Soenneker.Blazor.Consumer 11.0.2018

Soenneker.Blazor.Consumer

A typed base class for app-specific Blazor API consumers that return OperationResult<TResponse> from common CRUD and upload requests.

Installation

dotnet add package Soenneker.Blazor.Consumer

Define a consumer

Consumer<TResponse> has a protected constructor. Derive a concrete consumer and choose the resource URI prefix once:

using Microsoft.Extensions.Logging;
using Soenneker.Blazor.ApiClient.Abstract;
using Soenneker.Blazor.Consumer;

public sealed class TodoConsumer : Consumer<TodoDto>
{
    public TodoConsumer(
        IApiClient apiClient,
        ILogger<Consumer<TodoDto>> logger,
        IConfiguration configuration)
        : base(apiClient, logger, "todos")
    {
        apiClient.Initialize(
            configuration["Api:BaseUrl"]!,
            requestResponseLogging: false);
    }
}

Register the API client and concrete consumer as scoped services:

using Soenneker.Blazor.ApiClient.Registrars;

builder.Services.AddApiClientAsScoped();
builder.Services.AddScoped<TodoConsumer>();

Use it

OperationResult<TodoDto> result = await todoConsumer.Get(
    id: "42",
    cancellationToken: cancellationToken);

if (result.Succeeded)
{
    TodoDto? todo = result.Value;
}
else
{
    ProblemDetailsDto? problem = result.Problem;
}

The generic response type is fixed for Get, Create, Post, Update, Put, and Delete. GetAll returns OperationResult<PagedResult<TodoDto>>; Upload returns OperationResult<FileUploadResponse>.

Default routes

For a prefix of todos, the convenience overloads build these relative URIs:

overrideUri replaces the entire default URI. Use the RequestOptions overloads when the endpoint does not follow these conventions or when per-request anonymity and logging flags are needed. allowAnonymous defaults to false for JSON requests.

Responses are deserialized into the success value for successful status codes or into problem details for error responses. A response body that does not match the expected JSON shape produces a failed OperationResult; transport, authentication, and cancellation failures may still throw.

Uploads use multipart fields named file and json. The underlying API client disposes the supplied upload stream after the request, so do not reuse it.