WebApiClient：如何快速上手这个比Refit更强大的REST API库
【免费下载链接】WebApiClient A REST API library with better functionality, performance, and scalability than refit 
项目地址: https://gitcode.com/gh_mirrors/we/WebApiClient
WebApiClient是一个功能更强大、性能更出色且扩展性更强的REST API库，相比Refit，它为开发者提供了更简洁的接口定义方式和更灵活的配置选项。本文将带你快速掌握WebApiClient的核心功能和使用方法，让你轻松构建高效的API调用服务。
WebApiClient的官方Logo，代表着高效、可靠的API调用体验
🚀 准备工作：环境与依赖
WebApiClientCore要求项目的.NET版本支持.NET Standard 2.1，并且具备依赖注入的环境。无论是在ASP.NET Core应用还是控制台应用中，都可以轻松集成WebApiClient。
📦 从NuGet安装核心包
WebApiClient提供了多个NuGet包，满足不同场景的需求：
- 基础包：WebApiClientCore
- OAuth2扩展：WebApiClientCore.Extensions.OAuths
- Json.NET扩展：WebApiClientCore.Extensions.NewtonsoftJson
- JsonRpc扩展：WebApiClientCore.Extensions.JsonRpc
- OpenApi代码生成工具：WebApiClientCore.OpenApi.SourceGenerator
你可以根据项目需求选择安装相应的包，基础功能只需安装WebApiClientCore即可。
🔨 三步上手WebApiClient
1️⃣ 声明API接口
使用WebApiClient最核心的步骤是声明API接口。通过简洁的特性标记，你可以轻松定义API的请求方式、路径和参数：
[LoggingFilter]
[HttpHost("http://localhost:5000/")]
public interface IUserApi
{
[HttpGet("api/users/{id}")]
Task<User> GetAsync(string id);
[HttpPost("api/users")]
Task<User> PostAsync([JsonContent] User user);
}
public class User
{
[JsonPropertyName("account")]
public string Account { get; set; } = string.Empty;
public string Password { get; set; } = string.Empty;
}
以上代码定义了一个用户API接口，包含获取用户和创建用户两个方法。通过特性，我们指定了基础URL、HTTP方法、请求路径和参数序列化方式。
2️⃣ 注册和配置接口
在项目中注册WebApiClient非常简单，支持ASP.NET Core和控制台应用等多种场景：
ASP.NET Core应用
public void ConfigureServices(IServiceCollection services)
{
services.AddHttpApi<IUserApi>().ConfigureHttpApi(o =>
{
o.UseLogging = Environment.IsDevelopment();
o.HttpHost = new Uri("http://localhost:5000/");
// 配置序列化选项
o.JsonSerializeOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
o.JsonDeserializeOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
});
}
控制台应用
public static void Main(string[] args)
{
var services = new ServiceCollection();
services.AddHttpApi<IUserApi>().ConfigureHttpApi(o =>
{
o.UseLogging = Environment.IsDevelopment();
o.HttpHost = new Uri("http://localhost:5000/");
});
}
如果项目中有多个接口，还可以进行全局配置，作为所有接口的默认初始配置：
services.AddWebApiClient().ConfigureHttpApi(o =>
{
o.JsonSerializeOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
o.JsonDeserializeOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
o.KeyValueSerializeOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
});
3️⃣ 注入和调用接口
注册完成后，就可以在需要的地方注入并使用API接口了：
在Scoped或Transient服务中注入
public class YourService
{
private readonly IUserApi userApi;
public YourService(IUserApi userApi)
{
this.userApi = userApi;
}
public async Task GetAsync()
{
var user = await this.userApi.GetAsync(id: "id001");
// 处理用户数据
}
}
在Singleton服务中注入
public class YourService
{
private readonly IServiceScopeFactory serviceScopeFactory;
public YourService(IServiceScopeFactory serviceScopeFactory)
{
this.serviceScopeFactory = serviceScopeFactory;
}
public async Task GetAsync()
{
using var scope = this.serviceScopeFactory.CreateScope();
var userApi = scope.ServiceProvider.GetRequiredService<IUserApi>();
var user = await userApi.GetAsync(id: "id001");
// 处理用户数据
}
}
📚 深入学习资源
WebApiClient提供了丰富的文档和示例，帮助你深入了解其强大功能：
- 官方指南：docs/guide/
- 高级用法：docs/guide/5_advanced.md
- 认证扩展：docs/guide/6_auth-token-extension.md
- JSON序列化：docs/guide/7_json-net-extension.md
🔍 总结
WebApiClient作为一个比Refit更强大的REST API库，通过简洁的接口定义、灵活的配置选项和丰富的扩展功能，极大地简化了API调用的开发过程。无论是小型项目还是大型应用，WebApiClient都能为你提供高效、可靠的API调用体验。
现在就开始使用WebApiClient，体验更强大的API调用方式吧！如果你想了解更多细节，可以查阅完整的官方文档或查看示例代码。
【免费下载链接】WebApiClient A REST API library with better functionality, performance, and scalability than refit 项目地址: https://gitcode.com/gh_mirrors/we/WebApiClient
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
