Lyo.Api.Client 1.0.1

Lyo.Api.Client

HTTP client tailored for Lyo-shaped minimal APIs: JSON in/out, gzip/brotli/deflate handling, query-string encoding for GET DTOs, file upload helpers, and System.Text.Json parity with server options when you wire them.

Implements IDisposable (ApiClient disposes underlying resources—resolve via IHttpClientFactory so lifetimes stay correct in DI).

Examples

DI registration

services.AddLyoApiClient(
    optionsOverride: o => {
        o.BaseUrl = "https://api.example.com/";
        o.EnableAutoResponseDecompression = true;
        o.AcceptEncodings = ["gzip", "br"];
        o.RequestCompression = ApiRequestCompressionType.Gzip;
        o.RequestCompressionMinBytes = 4 * 1024;
    },
    httpClientBuilderOverride: b => b.AddStandardResilienceHandler());

Surface (IApiClient)

Serialization

• GetSerializerOptions() exposes effective JsonSerializerOptions—use the same instance for ad-hoc serializers in your worker to avoid schema drift.

GET

• GetAsAsync<TResult>(uri, beforeRequest, ct) basic JSON GET.
• GetAsAsync<TRequest, TResult>(uri, query, enumerableDelimiter, …) serializes TRequest properties as query parameters (helps mirror Lyo.Api endpoints that accept flattened DTO queries).

Bodies & verbs

• PostAsAsync / PutAsAsync / PatchAsAsync / DeleteAsAsync map to JSON content (generic + non-generic overloads).
• PostAsBinaryAsync for raw byte returns (exports, generated PDFs, etc.).

Files

• GetFileAsync / GetFileWithTypeAsync buffer entire payload.
• GetFileStreamAsync returns Stream + filename + length without forcing memory spikes—caller disposes underlying HttpResponseMessage per XML contract.
• PostFileAsAsync overloads stream/byte[]/path + FileTypeInfo for MIME + extension hints.

Customization hook

Each method accepts optional Action<HttpRequestMessage> to append auth headers (Authorization: Bearer …), correlation ids, Accept overrides, or tracing headers.

Throws ApiException wrapping non-success status codes with contextual payload extraction (see class for available properties). ApiException derives from Lyo.Exceptions.Models.HttpException, so callers can handle it through the shared HTTP hierarchy: StatusCode and ErrorCode (populated from the first parsed LyoProblemDetails error code) come from the base type, and IsTransient is true for 408/429/502/503/504 — which lets Lyo.Resilience retry pipelines pick it up automatically.

Options (ApiClientOptions)

Configuration section: ApiClientOptions.SectionName = "ApiClient". Integration-specific clients (Discord, Endato, ESPN, Typecast, …) subclass this type and shadow SectionName so all transport flags bind under their own section.

Pair request compression with a host that registers AddRequestDecompression (ASP.NET Core 7+) so the server can decode the body.

Compression & performance

• Adds Accept-Encoding headers from AcceptEncodings (duplicates removed, case normalized).
• Sets HttpClientHandler.AutomaticDecompression when EnableAutoResponseDecompression is true (maps gzip/deflate/br where the target framework supports Brotli).
• Returns the underlying IHttpClientBuilder so callers can chain resilience, message handlers, or named-client overrides.

DI registration

clientName defaults to nameof(IApiClient) for named HttpClientFactory resolution. Bind from configuration with the standard services.Configure<ApiClientOptions>(config.GetSection(ApiClientOptions.SectionName)) if you prefer the section route.

Typical integration tests

Spin WebApplicationFactory for your API host, call through IApiClient, assert ApiException.StatusCode ProblemDetails bodies using shared models from Lyo.Api.Models.

Related

• Lyo.Api.Models — payloads + error contracts.
• Lyo.Api — authoritative server behavior you are mirroring client-side.

Dependencies

Generated from ProjectReference / PackageReference (same model as docs/Lyo.ProjectGraph.html).

• Lyo.Api.Models — (direct, lyo)
• Lyo.Common — (direct, lyo)
• Lyo.Diagnostic — (direct, lyo)
• Lyo.Exceptions — (direct, lyo)
• Microsoft.Extensions.Http 10.0.5 — (direct, microsoft)
• Microsoft.Extensions.Logging.Abstractions 10.0.5 — (direct, microsoft)
• Lyo.DateAndTime — (transitive, lyo)
• Lyo.Hashing — (transitive, lyo)
• Lyo.PackageMetadata — (transitive, lyo)
• Lyo.Query.Models — (transitive, lyo)
• Microsoft.Extensions.DependencyInjection.Abstractions 10.0.5 — (transitive, microsoft)
• System.IO.Hashing 10.0.5 — (transitive, microsoft, net10.0)
• System.Memory 4.6.3 — (transitive, microsoft, netstandard2.0)
• System.Text.Json 10.0.5 — (transitive, microsoft, netstandard2.0)
• System.Threading.Tasks.Extensions 4.6.3 — (transitive, microsoft)