.net core 中 WebApiClientCore的使用示例代码

 "IUserApi": { "HttpHost": "http://www.webappiclient.com/", "UseParameterPropertyValidate": false, "UseReturnValuePropertyValidate": false, "JsonSerializeOptions": { "IgnoreNullValues": true, "WriteIndented": false } }

services .ConfigureHttpApi(Configuration.GetSection(nameof(IUserApi))) .ConfigureHttpApi(o => { // 符合国情的不标准时间格式，有些接口就是这么要求必须不标准 o.JsonSerializeOptions.Converters.Add(new JsonDateTimeConverter("yyyy-MM-dd HH:mm:ss")); }); 

/// 
 /// 表示HttpApi选项 /// 
 public class HttpApiOptions { /// 
 /// 获取或设置Http服务完整主机域名 /// 例如http://www.abc.com/或http://www.abc.com/path/ /// 设置了HttpHost值，HttpHostAttribute将失效 /// 
 public Uri? HttpHost { get; set; } /// 
 /// 获取或设置是否使用的日志功能 /// 
 public bool UseLogging { get; set; } = true; /// 
 /// 获取或设置请求头是否包含默认的UserAgent /// 
 public bool UseDefaultUserAgent { get; set; } = true; /// 
 /// 获取或设置是否对参数的属性值进行输入有效性验证 /// 
 public bool . { get; set; } = true; /// 
 /// 获取或设置是否对返回值的属性值进行输入有效性验证 /// 
 public bool UseReturnValuePropertyValidate { get; set; } = true; /// 
 /// 获取json序列化选项 /// 
 public JsonSerializerOptions JsonSerializeOptions { get; } = CreateJsonSerializeOptions(); /// 
 /// 获取json反序列化选项 /// 
 public JsonSerializerOptions JsonDeserializeOptions { get; } = CreateJsonDeserializeOptions(); /// 
 /// xml序列化选项 /// 
 public XmlWriterSettings XmlSerializeOptions { get; } = new XmlWriterSettings(); /// 
 /// xml反序列化选项 /// 
 public XmlReaderSettings XmlDeserializeOptions { get; } = new XmlReaderSettings(); /// 
 /// 获取keyValue序列化选项 /// 
 public KeyValueSerializerOptions KeyValueSerializeOptions { get; } = new KeyValueSerializerOptions(); /// 
 /// 获取自定义数据存储的字典 /// 
 public Dictionary Properties { get; } = new Dictionary(); /// 
 /// 获取接口的全局过滤器集合 /// 
 public IList GlobalFilters { get; } = new List(); /// 
 /// 创建序列化JsonSerializerOptions /// 
 private static JsonSerializerOptions CreateJsonSerializeOptions() { return new JsonSerializerOptions { PropertyNameCaseInsensitive = true, PropertyNamingPolicy = JsonNamingPolicy.CamelCase, DictionaryKeyPolicy = JsonNamingPolicy.CamelCase, Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping }; } /// 
 /// 创建反序列化JsonSerializerOptions /// 
 ///  private static JsonSerializerOptions CreateJsonDeserializeOptions() { var options = CreateJsonSerializeOptions(); options.Converters.Add(JsonCompatibleConverter.EnumReader); options.Converters.Add(JsonCompatibleConverter.DateTimeReader); return options; } } 

 public class TestTokenProvider : TokenProvider { private readonly IConfiguration _configuration; public TestTokenProvider(IServiceProvider services,IConfiguration configuration) : base(services) { _configuration = configuration; } protected override Task RefreshTokenAsync(IServiceProvider serviceProvider, string refresh_token) { return this.RefreshTokenAsync(serviceProvider, refresh_token); } protected override async Task RequestTokenAsync(IServiceProvider serviceProvider) { LoginInput login = new LoginInput(); login.UserNameOrEmailAddress = "admin"; login.Password = "bb123456"; var result = await serviceProvider.GetRequiredService().RequestToken(login).Retry(maxCount: 3); return result; } } 

services.AddTokenProvider();

class UriQueryOAuthTokenHandler : OAuthTokenHandler { /// 
 /// token应用的http消息处理程序 /// 
 /// token提供者 public UriQueryOAuthTokenHandler(ITokenProvider tokenProvider) : base(tokenProvider) { } /// 
 /// 应用token /// 
 ///  ///  protected override void UseTokenResult(HttpRequestMessage request, TokenResult tokenResult) { // var builder = new UriBuilder(request.RequestUri); // builder.Query += "mytoken=" + Uri.EscapeDataString(tokenResult.Access_token); // request.RequestUri = builder.Uri; var uriValue = new UriValue(request.RequestUri).AddQuery("myToken", tokenResult.Access_token); request.RequestUri = uriValue.ToUri(); } } 

services .AddHttpApi() .AddOAuthTokenHandler((s, tp) => new UriQueryOAuthTokenHandler(tp)); //自定义TokoenProvider使用自定义OAuthTokenHandler apiBulider.AddOAuthTokenHandler((sp,token)=> { token=sp.GetRequiredService(); return new UrlTokenHandler(token); },WebApiClientCore.Extensions.OAuths.TypeMatchMode.TypeOrBaseTypes);

public interface IUserApi { [HttpPatch("api/users/{id}")] Task PatchAsync(string id, JsonPatchDocument doc); } 

var doc = new JsonPatchDocument(); doc.Replace(item => item.Account, "laojiu"); doc.Replace(item => item.Email, "laojiu@qq.com"); 

PATCH /api/users/id001 HTTP/1.1 Host: localhost:6000 User-Agent: WebApiClientCore/1.0.0.0 Accept: application/json; q=0.01, application/xml; q=0.01 Content-Type: application/json-patch+json [{"op":"replace","path":"/account","value":"laojiu"},{"op":"replace","path":"/email","value":"laojiu@qq.com"}] 

try { var model = await api.GetAsync(); } catch (HttpRequestException ex) when (ex.InnerException is ApiInvalidConfigException configException) { // 请求配置异常 } catch (HttpRequestException ex) when (ex.InnerException is ApiResponseStatusException statusException) { // 响应状态码异常 } catch (HttpRequestException ex) when (ex.InnerException is ApiException apiException) { // 抽象的api异常 } catch (HttpRequestException ex) when (ex.InnerException is SocketException socketException) { // socket连接层异常 } catch (HttpRequestException ex) { // 请求异常 } catch (Exception ex) { // 异常 } 

 GetNumberTemplateForEditOutput put = new GetNumberTemplateForEditOutput(); var res = await _testApi.GetForEdit(id).Retry(maxCount: 1).WhenCatchAsync(async p => { if (p.StatusCode == HttpStatusCode.Unauthorized) { await Token();//当http请求异常时报错,重新请求一次，保证token一直有效 } }); put = res.Result; return put; 

[HttpHost("请求地址")]//请求地址域名 public interface ITestApi : IHttpApi { [OAuthToken]//权限 [JsonReturn]//设置返回格式 [HttpGet("/api/services/app/NumberingTemplate/GetForEdit")]//请求路径 ITask> GetForEdit([Required] string id);//请求参数声明 [HttpPost("api/TokenAuth/Authenticate")] ITask RequestToken([JsonContent] AuthenticateModel login); } 

/// 
 /// WebApiClient扩展类 /// 
 public static class WebApiClientExentions { public static IServiceCollection AddWebApiClietHttp(this IServiceCollection services, Action? options = null) where THttp : class, IHttpApi { HttpApiOptions option = new HttpApiOptions(); option.JsonSerializeOptions.Converters.Add(new JsonDateTimeConverter("yyyy-MM-dd HH:mm:ss")); option.UseParameterPropertyValidate = true; if(options != null) { options.Invoke(option); } services.AddHttpApi().ConfigureHttpApi(p => p = option); return services; } public static IServiceCollection AddWebApiClietHttp(this IServiceCollection services,IConfiguration configuration) where THttp : class, IHttpApi { services.AddHttpApi().ConfigureHttpApi((Microsoft.Extensions.Configuration.IConfiguration)configuration); return services; } public static IServiceCollection AddWebApiClientHttpWithTokeProvider(this IServiceCollection services, Action? options = null) where THttp : class, IHttpApi where TTokenProvider : class, ITokenProvider { services.AddWebApiClietHttp(options); services.AddTokenProvider(); return services; } public static IServiceCollection AddWebApiClientHttpWithTokeProvider(this IServiceCollection services, IConfiguration configuration) where THttp : class, IHttpApi where TTokenProvider : class, ITokenProvider { services.AddWebApiClietHttp(configuration); services.AddTokenProvider(); return services; } } 

services.AddWebApiClientHttpWithTokeProvider();