SolTechnology.Core.ApiClient
0.3.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package SolTechnology.Core.ApiClient --version 0.3.0
NuGet\Install-Package SolTechnology.Core.ApiClient -Version 0.3.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SolTechnology.Core.ApiClient" Version="0.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SolTechnology.Core.ApiClient --version 0.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: SolTechnology.Core.ApiClient, 0.3.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install SolTechnology.Core.ApiClient as a Cake Addin #addin nuget:?package=SolTechnology.Core.ApiClient&version=0.3.0 // Install SolTechnology.Core.ApiClient as a Cake Tool #tool nuget:?package=SolTechnology.Core.ApiClient&version=0.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Overview
The SolTechnology.Core.ApiClient library provides minimum functionality needed for API calls over HTTP. It handles needed services registration and configuration and a result provides HttpClients.
Registration
For installing the library, reference SolTechnology.Core.ApiClient nuget package and invoke AddApiClient<IApiClient, ApiClient>("http-client-name") service collection extension method:
services.AddApiClient<IFootballDataApiClient, FootballDataApiClient>("football-data"); //has to match the name from configuration
Configuration
- The first option is to create an appsettings.json section:
"Configuration": {
"ApiClients": [
{
"Name": "football-data",
"BaseAddress": "http://api.football-data.org",
"Headers": [
{
"Name": "X-Auth-Token",
"Value": ""
}
]
},
{
"Name": "api-football",
"BaseAddress": "https://api-football-v1.p.rapidapi.com",
"Headers": [
{
"Name": "x-rapidapi-host",
"Value": ""
},
{
"Name": "x-rapidapi-key",
"Value": ""
}
]
}
]
}
- Alternatevely the same settings can be provided by optional parameter during registration:
var footballDataApiConfiguration = new ApiClientConfiguration
{
BaseAddress = "http://api.football-data.org",
Name = "football-data",
Headers = new List<Header>
{
new Header
{
Name = "X-Auth-Token",
Value = ""
}
}
};
services.AddApiClient<IFootballDataApiClient, FootballDataApiClient>("football-data", footballDataApiConfiguration); //has to match the name from configuration
Usage
- Inject HttpClient to previously registered class
public FootballDataApiClient(HttpClient httpClient)
{
_httpClient = httpClient;
}
- Invoke the http method
var apiResult = await _httpClient.GetAsync<MatchModel>($"v2/matches/{matchApiId}");
- The library supports Get, Post, Put and Delete http operations as well as Json and Avro data formats.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net6.0
- AvroConvert (>= 3.3.0)
- Microsoft.Extensions.Configuration.Abstractions (>= 7.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 7.0.2)
- Microsoft.Extensions.Http (>= 7.0.0)
- Microsoft.Extensions.Http.Polly (>= 7.0.0)
- Microsoft.Extensions.Options (>= 7.0.0)
- Newtonsoft.Json (>= 13.0.1)
- Polly (>= 7.2.3)
- polly.contrib.WaitAndRetry (>= 1.1.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.