Very easy to use httpclient for webapi. call remote methods like local methods. support async methods too.
- Install the
WebApiEasyInvokernuget package - Define a interface which inherit
IWebApiInvoker<T> - Define interface method
- Chose and use
HttpFullUrlAttribute,HttpHostAttribute,HttpUrlAttribute... to decorate interface or method - Use
WebApiExecutionGenerator.Create<T>()to auto build an excutor - Use the excutor
For example
public interface ITest : IWebApiInvoker<ITest>
{
[HttpFullUrl("https://www.cnblogs.com/")]
string TestFullUrl();
[HttpFullUrl("https://www.cnblogs.com/")]
Task<string> TestFullUrlAsync();
}[HttpHost("http://localhost:49386/")]
public interface IArgumentTest : IWebApiInvoker<IArgumentTest>
{
[HttpUrl("/api/students")]
string TestFormRequest1([ToBody(FormatType.Form)]Student student);
[HttpUrl("/api/arg")]
Foo TestFormRequest2([ToBody(FormatType.Form)]string arg1);
}var test = WebApiExecutionGenerator.Create<ITest>();
var response = test.TestFullUrl();
Console.WriteLine(response);
var response1 = await test.TestFullUrlAsync();
Console.WriteLine(response1);Also you can inject the excutor if you have a DI module.
For example(Asp.net core)
- in
Startup.ConfigureServicesmethod
services.AddWebApiEasyInvoker();- defined
IServiceBinterface
using WebApiEasyInvoker;
using WebApiEasyInvoker.Attributes;
namespace ServiceA.ThirdService
{
[HttpHost("http://localhost:5402/WeatherForecast")]
public interface IServiceB : IWebApiInvoker<IServiceB>
{
[HttpUrl("")]
List<WeatherForecast> GetWeathers();
}
}- inject
IServiceBto the place you want to use
namespace ServiceA.Controllers
{
[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
private readonly ILogger<WeatherForecastController> _logger;
private readonly IServiceB _serviceB;
public WeatherForecastController(ILogger<WeatherForecastController> logger,
IServiceB serviceB)
{
_logger = logger;
//config if necessary
_serviceB = serviceB.Config(new HttpConfig { Logger = logger });
}
[HttpGet]
public IEnumerable<WeatherForecast> Get()
{
//will request to serviceB web api: get http://localhost:5402/WeatherForecast
var serviceBData = _serviceB.GetWeathers();
return serviceBData;
}
}
}If you have a string like {name} in Http*Attribute and also a argument have the same name,the value of the argument will replace the {name} placeholder.
The name type must be value type
[HttpHost("http://localhost:49386/")]
public interface IArgumentTest : IWebApiInvoker<IArgumentTest>
{
[HttpUrl("/api/students/{classRoom}")]
string TestFormRequest1(string classRoom,[ToBody(FormatType.Form)]Student student);
}
public static void main()
{
//the request url will be http://localhost:49386/api/students/c1
WebApiExecutionGenerator.Create<IArgumentTest>().TestFormRequest1("c1",student);
}If you use ToQueryAttribute, the argument will combine to the url as query string.
For example
public class Student
{
public string Name { get; set; }
public int Age { get; set; }
}
[HttpHost("http://localhost:49386/")]
public interface IArgumentTest : IWebApiInvoker<IArgumentTest>
{
[HttpUrl("/api/students/{classRoom}")]
string TestFormRequest1(string classRoom,[ToQuery]Student student);
}
public static void main()
{
var student = new Student
{
Name = "bob",
Age = 20
};
//the request url will be http://localhost:49386/api/students/c1?Name=bob&Age=20
WebApiExecutionGenerator.Create<IArgumentTest>().TestFormRequest1("c1",student);
}In every excutor, you have the Config method. That have an HttpConfig argument. Use this can config Timeout and RequestHeaders and Logger
public interface IWebApiInvoker<ITarget>
{
/// <summary>
/// Config web request
/// </summary>
/// <param name="apiConfig"></param>
/// <returns></returns>
ITarget Config(HttpConfig apiConfig);
}
public class HttpConfig
{
public TimeSpan Timeout { get; set; } = TimeSpan.FromSeconds(100);
public HttpRequestHeaders RequestHeaders { get; set; }
public ILogger Logger { get; set; }
}If you want to call serviceB which registed in Consul,you can install nuget WebApiEasyInvoker.Consul and use AddWebApiEasyInvoker(EasyInvokerConsulConfig) instead of AddWebApiEasyInvoker()
services.AddWebApiEasyInvoker(new EasyInvokerConsulConfig
{
Address = "http://localhost:8500"
});[ConsulService("serviceB", BalanceType.LeastConnection)]
public interface IConsulServiceB : IWebApiInvoker<IConsulServiceB>
{
[ConsulPath("/WeatherForecast", HttpMethodKind.Get)]
List<WeatherForecast> GetWeathers();
}- Polly in build
Consul extend package(Provided byWebApiEasyInvoker.Consul)- Eureka extend package
- Etcd extend package
- Zookeeper extend package
This project was based on DispatchProxyAsync (I only have some little change), witch created by gencebay and tahaipek, very thanks to them.