OptimusFramework.Api.Client
2.0.1
dotnet add package OptimusFramework.Api.Client --version 2.0.1
NuGet\Install-Package OptimusFramework.Api.Client -Version 2.0.1
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="OptimusFramework.Api.Client" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="OptimusFramework.Api.Client" Version="2.0.1" />
<PackageReference Include="OptimusFramework.Api.Client" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add OptimusFramework.Api.Client --version 2.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: OptimusFramework.Api.Client, 2.0.1"
#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.
#:package OptimusFramework.Api.Client@2.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=OptimusFramework.Api.Client&version=2.0.1
#tool nuget:?package=OptimusFramework.Api.Client&version=2.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
OptimusFramework.Api.Client
HTTP client library for consuming Optimus Framework APIs. Provides typed client interfaces using Refit for strongly-typed REST API communication.
Features
- Typed HTTP Clients: Refit-based interfaces for consuming framework APIs
- Standard Response Handling: Works with
ApiResponse<TData>response format - Dependency Injection Ready: Integrates with Microsoft.Extensions.DependencyInjection
Dependencies
- Refit for declarative REST API clients
- OptimusFramework.Utils for shared DTOs
Installation
dotnet add package OptimusFramework.Api.Client
Usage
using Refit;
using OptimusFramework.Utils.Dtos.Request;
// Define your API interface
public interface IMyApiClient
{
[Post("/api/products/list")]
Task<ApiResponse<PagedListDto<ProductDto>>> List([Body] PagedListParam<ProductFilter> param);
[Get("/api/products/getbykey/{id}")]
Task<ApiResponse<ProductDto>> GetByKey(int id);
}
// Register in DI
services.AddRefitClient<IMyApiClient>()
.ConfigureHttpClient(c => c.BaseAddress = new Uri("https://api.example.com"));
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- OptimusFramework.Utils (>= 2.0.1)
- Refit (>= 7.2.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.