Soenneker.Apollo.HttpClients 11.0.89

Soenneker.Apollo.HttpClients

A cached, authenticated HttpClient provider for Apollo's REST API.

This is the HTTP transport layer used by Soenneker.Apollo.OpenApiClientUtil. Most applications that want the generated, typed Apollo API should register that higher-level package instead. Use this package directly when you need the configured HttpClient itself.

Installation

dotnet add package Soenneker.Apollo.HttpClients

Configuration

Add the Apollo API key to configuration:

{
  "Apollo": {
    "ApiKey": "your-api-key"
  }
}

The available keys are:

For example, a bearer-style gateway can be configured with an Authorization header and a Bearer {token} template.

Keep API keys in user secrets, environment variables, or a secret store rather than committing them to appsettings.json.

Registration and usage

using Soenneker.Apollo.HttpClients.Registrars;

builder.Services.AddApolloOpenApiHttpClientAsSingleton();

Inject the abstraction and retrieve the cached client:

using Soenneker.Apollo.HttpClients.Abstract;

public sealed class ApolloTransportProbe
{
    private readonly IApolloOpenApiHttpClient _clientProvider;

    public ApolloTransportProbe(IApolloOpenApiHttpClient clientProvider)
    {
        _clientProvider = clientProvider;
    }

    public async ValueTask<Uri?> GetBaseAddress(
        CancellationToken cancellationToken)
    {
        HttpClient client = await _clientProvider.Get(cancellationToken);
        return client.BaseAddress;
    }
}

Get creates the client on first use and returns the same cached instance afterward. The client has its BaseAddress and authentication header configured from IConfiguration.

Scoped registration is available, but the underlying HTTP client cache remains a singleton:

builder.Services.AddApolloOpenApiHttpClientAsScoped();

Lifetime behavior

• Reuse the returned client; do not dispose it after individual requests.
• Configuration is evaluated when the cached client is created. Changing configuration does not mutate an already-created client.
• Let the dependency-injection container dispose IApolloOpenApiHttpClient. Disposal removes and disposes its named client from the shared cache.
• The registration methods use TryAdd for the provider, so an application-supplied implementation is preserved.

For typed endpoint methods and generated response models, use Soenneker.Apollo.OpenApiClientUtil.

API