Getting Started

Prerequisites

WebApiClientCore requires a dependency injection environment and supports the following target frameworks:

Target Framework	Notes
netstandard2.1	Covers .NET Core 3.0+, .NET 5+, and platforms such as Xamarin/MAUI that support netstandard2.1
net5.0	Native target
net8.0	Native target, IsAotCompatible, supports AOT publishing
net10.0	Native target, IsAotCompatible, supports AOT publishing (v2.1.6+)

In other words, projects on .NET Core 3.1 and above, and .NET 5/6/7/8/9/10, can use it directly. See AOT Publishing for AOT details.

Install from NuGet

Package Name	Description
WebApiClientCore	Core package
WebApiClientCore.Extensions.OAuths	OAuth2 and token management extension
WebApiClientCore.Extensions.NewtonsoftJson	Newtonsoft Json.NET extension
WebApiClientCore.Extensions.JsonRpc	JSON-RPC invocation extension
WebApiClientCore.OpenApi.SourceGenerator	A dotnet tool that parses local or remote OpenAPI documents to generate WebApiClientCore interface code

Declare Interface

[LoggingFilter]
[HttpHost("http://localhost:5000/")]
public interface IUserApi
{
    [HttpGet("api/users/{id}")]
    Task<User> GetAsync(string id, CancellationToken token = default);

    // POST application/json content
    [HttpPost("api/users")]
    Task<User> PostJsonAsync([JsonContent] User user, CancellationToken token = default);

    // POST application/xml content
    [HttpPost("api/users")]
    Task<User> PostXmlAsync([XmlContent] User user, CancellationToken token = default);

    // POST x-www-form-urlencoded content
    [HttpPost("api/users")]
    Task<User> PostFormAsync([FormContent] User user, CancellationToken token = default);

    // POST multipart/form-data content
    [HttpPost("api/users")]
    Task<User> PostFormDataAsync([FormDataContent] User user, FormDataFile avatar, CancellationToken token = default);
}

public class User
{ 
    [JsonPropertyName("account")]
    public string Account { get; set; } = string.Empty;

    public string Password { get; set; } = string.Empty;
}

Register Services

ASP.NET Core

// Program.cs
services.AddHttpApi<IUserApi>().ConfigureHttpApi(o =>
{
    o.HttpHost = new Uri("http://localhost:5000/");
});

Console Application

var services = new ServiceCollection();
services.AddHttpApi<IUserApi>().ConfigureHttpApi(o =>
{
    o.HttpHost = new Uri("http://localhost:5000/");
});

var provider = services.BuildServiceProvider();
var userApi = provider.GetRequiredService<IUserApi>();

Using the Interface

public class UserService
{
    private readonly IUserApi _userApi;

    public UserService(IUserApi userApi)
    {
        _userApi = userApi;
    }

    public async Task<User?> GetUserAsync(string id)
    {
        try
        {
            return await _userApi.GetAsync(id);
        }
        catch (HttpRequestException ex)
        {
            // Handle exception
            Console.WriteLine($"Request failed: {ex.Message}");
            return null;
        }
    }
}

Common Attributes Quick Reference

Attribute	Purpose
[HttpGet]	GET request
[HttpPost]	POST request
[HttpPut]	PUT request
[HttpDelete]	DELETE request
[JsonContent]	JSON request body
[FormContent]	Form request body
[PathQuery]	Path or query parameter
[HttpHost]	Interface base address
[LoggingFilter]	Request logging

Next Steps

• Architecture Overview
• HTTP Attributes
• Content Attributes
• Exception Handling