ZeroAlloc.Rest.Tools 0.1.2

ZeroAlloc.Rest

ZeroAlloc.Rest is a source-generated, Native AOT-compatible REST client for .NET 10+. Define your HTTP API as a C# interface — the Roslyn generator emits a fully type-safe, zero-reflection implementation at compile time. No runtime code generation, no IL emit, no allocations beyond the HTTP layer itself.

Install

dotnet add package ZeroAlloc.Rest
dotnet add package ZeroAlloc.Rest.Generator
dotnet add package ZeroAlloc.Rest.SystemTextJson

Or via <PackageReference>:

<PackageReference Include="ZeroAlloc.Rest" Version="x.y.z" />
<PackageReference Include="ZeroAlloc.Rest.Generator"
                  Version="x.y.z"
                  OutputItemType="Analyzer"
                  ReferenceOutputAssembly="false" />
<PackageReference Include="ZeroAlloc.Rest.SystemTextJson" Version="x.y.z" />

Quick Start

1. Define your API interface:

using ZeroAlloc.Rest.Attributes;

[ZeroAllocRestClient]
public interface IUserApi
{
    [Get("/users/{id}")]
    Task<UserDto> GetUserAsync(int id, CancellationToken ct = default);

    [Get("/users")]
    Task<List<UserDto>> ListUsersAsync([Query] string? name = null, CancellationToken ct = default);

    [Post("/users")]
    Task<UserDto> CreateUserAsync([Body] CreateUserRequest request, CancellationToken ct = default);

    [Delete("/users/{id}")]
    Task DeleteUserAsync(int id, CancellationToken ct = default);
}

2. Register in DI:

builder.Services.AddIUserApi(options =>
{
    options.BaseAddress = new Uri("https://api.example.com");
    options.UseSerializer<SystemTextJsonSerializer>();
});

3. Inject and use:

public class UserService(IUserApi api)
{
    public Task<UserDto> GetAsync(int id) => api.GetUserAsync(id);
}

The generator produces UserApiClient — a sealed class implementing IUserApi — at compile time. No reflection, no proxies, no DynamicMethod.

Performance

Measured on .NET 10.0.4, Windows 11, X64. In-memory handler; no real network I/O. See docs/benchmarks.md for methodology and full results.

Features

• Source-generated — zero runtime reflection; compile-time type safety
• Native AOT compatible — no DynamicMethod, no IL emit, no Type.GetType
• Per-method serializer override — [Serializer(typeof(MySerializer))] for mixed protocols
• Path, query, body, and header parameters — {id}, [Query], [Body], [Header("X-Api-Key")]
• Result<T, HttpError> — typed success/error returns via ZeroAlloc.Results; no exception-throwing on 4xx/5xx
• OpenAPI code generation — OpenApiInterfaceGenerator API + MSBuild <ZeroAllocApiSpec> task
• Pluggable serializers — System.Text.Json, MemoryPack, MessagePack, or bring your own
• IHttpClientFactory integration — AddI{Interface} generated extension method

Documentation

License

MIT