Skip to content

一款基于HttpClient封装,只需要定义c#接口并修饰相关特性,即可异步调用远程http接口的客户端库

License

Notifications You must be signed in to change notification settings

szg/WebApiClient

 
 

Repository files navigation

WebApiClient                     English

WebApiClient.JIT将替代旧的Laojiu.WebApiClient,在运行时使用Emit创建Http请求接口的代理类;
WebApiClient.AOT支持包括需要AOT的平台,在编译时插入Http请求接口的代理类IL指令到输出的程序集;

1 Nuget包

PM> install-package WebApiClient.JIT
支持 .net framework4.5 netstandard1.3 netcoreapp2.1

PM> install-package WebApiClient.AOT
支持 .net framework4.5 netstandard1.3 netcoreapp2.1

2. Http(s)请求

2.1 接口的声明

[HttpHost("http://www.webapiclient.com")] 
public interface IMyWebApi : IHttpApi
{
    // GET webapi/user?account=laojiu
    // Return 原始string内容
    [HttpGet("/webapi/user")]
    ITask<string> GetUserByAccountAsync(string account);

    // POST webapi/user  
    // Body Account=laojiu&password=123456
    // Return json或xml内容
    [HttpPost("/webapi/user")]
    ITask<UserInfo> UpdateUserWithFormAsync([FormContent] UserInfo user);
}

public class UserInfo
{
    public string Account { get; set; }

    [AliasAs("password")]
    public string Password { get; set; }

    [IgnoreSerialized]
    public string Email { get; set; }
}

2.2 接口的调用

static async Task TestAsync()
{
    var client = HttpApiClient.Create<IMyWebApi>();
    var user = new UserInfo { Account = "laojiu", Password = "123456" }; 
    var user1 = await client.GetUserByAccountAsync("laojiu");
    var user2 = await client.UpdateUserWithFormAsync(user);
}

3. 功能特性

  • 面向切面编程方式
  • 内置丰富的接口、方法和参数特性,支持使用自定义特性
  • 适应个性化需求的多个DataAnnotations特性
  • 灵活的ApiAcitonFilter、GobalFilter和IParameterable
  • 支持与外部HttpMessageHandler实例无缝衔接
  • 独一无二的请求异常条件重试(Retry)和异常处理(Handle)链式语法功能

4. 详细文档

5. 联系方式

6. 功能视图

功能脑图

About

一款基于HttpClient封装,只需要定义c#接口并修饰相关特性,即可异步调用远程http接口的客户端库

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 99.9%
  • Batchfile 0.1%