WebApiClient 教程与指南

WebApiClient 教程与指南

WebApiClient项目地址:https://gitcode.com/gh_mirrors/web/WebApiClient

1. 项目介绍

WebApiClient 是一个高度可扩展的、高性能的.NET HTTP客户端库，它通过声明式的C#接口来调用HTTP API，提供JSON、XML等多种序列化支持，并具有面向切面的功能，如拦截器、过滤器和日志。该库适用于.NET Framework 4.5+、.NET Core 2.0以及.NET Standard 2.0，旨在简化HTTP API客户端的开发并提高其效率。

主要特点包括：

• 语义化的声明接口
• 多样化的序列化支持
• .NET 8的代码裁剪和AOT
• 拦截器、过滤器和日志记录
• 自动代码生成（通过OpenApi文档）

2. 项目快速启动

首先，在你的项目中通过NuGet安装WebApiClient库：

Install-Package WebApiClient

接下来，创建一个C#接口并添加特性来声明HTTP API的方法：

using WebApiClient;
using System.Net.Http;

public interface IMyApi : IWebApiClient
{
    [HttpGet("/api/users/{id}")]
    Task<User> GetUserAsync(int id);

    [HttpPost("/api/users")]
    Task CreateUserAsync([FormContent] User user);
}

public class User 
{
    public string Name { get; set; }
    public int Age { get; set; }
}

然后，实例化并调用接口：

var myApi = new MyApi("http://your-api-url.com");
await myApi.GetUserAsync(1);          // GET请求
await myApi.CreateUserAsync(new User { Name = "John", Age = 30 });  // POST请求

3. 应用案例和最佳实践

授权管理

为了处理OAuth2令牌，你可以创建一个

TokenProvider

并将其注入到WebApiClient实例：

// 创建TokenProvider
var tokenProvider = new TokenProvider();

// 注册到依赖注入容器
services.AddSingleton(tokenProvider);

// 实例化WebApiClient时注入TokenProvider
var myApi = new MyApi("http://your-api-url.com", tokenProvider);

错误处理

可以通过拦截器来捕获和处理错误：

public class ErrorHandlerInterceptor : IApiActionFilter
{
    public async Task OnApiActionExecuting(ApiActionExecuteContext context)
    {
        try
        {
            await context.Next();
        }
        catch (Exception ex)
        {
            // 记录错误日志或者通知用户
        }
    }
}

// 注册拦截器
myApi.AddGlobalFilter<ErrorHandlerInterceptor>();

4. 典型生态项目

• WebApiClientCore.Extensions.JsonRpc: 为WebApiClient添加Json-RPC支持。
• WebApiClientCore.Extensions.NewtonsoftJson: 提供Newtonsoft.Json作为默认序列化器的扩展。
• WebApiClientCore.Extensions.OAuths: 包含对OAuth2认证的支持。

此外，还有一些代码生成工具，如用于解析Swagger JSON生成WebApiClient接口的工具，可以帮助简化接口声明。

希望这个教程能帮助你快速了解和使用WebApiClient库。更多高级特性和详细配置，请参考官方文档和示例项目。祝你在开发过程中一切顺利！

WebApiClient项目地址:https://gitcode.com/gh_mirrors/web/WebApiClient