DS.Foundation.WebApi 8.4.1

DS.Foundation.WebApi

Cliente HTTP para consumir APIs REST (en especial los microservicios DS), los contratos de request y response que esas APIs comparten, autorizadores (Bearer, OAuth2 por password, login simple), registro de requests en archivos o memoria, subida de archivos multipart y notificaciones a Slack.

• Target framework: netstandard2.0 (compatible con Blazor WebAssembly mediante IHttpClient).
• Dependencias: DS.Foundation, Microsoft.Extensions.Options, System.Text.Json.

Instalación

<PackageReference Include="DS.Foundation.WebApi" Version="8.4.1" />

Registro

Los clientes no se registran en DI: se crean con un contexto (WebApiConsumerContext o WebApiClientContext). Cree un contexto por API destino y reutilícelo, porque cada contexto crea su propio HttpClient.

SlackNotifier implementa IApplicationService, pero el paquete no expone un IServiceRepository, así que regístrelo a mano:

using DS.Foundation.WebApi.Notification;

builder.Services.Configure<SlackOptions>(builder.Configuration.GetSection("Slack"));
builder.Services.AddScoped<ISystemNotifier, SlackNotifier>(); // usa IOptionsSnapshot: debe ser scoped

Configuración

WebApiConsumerContext / WebApiClientContext

Con Authorization cargada, cada request lleva ese encabezado: si Type es Bearer, Authorization: Bearer <AccessToken>; si no, <Key>: <AccessToken>. Si hay Authentication, el request llama a Authorizer.Authorize(usuario, contraseña) cuando todavía no hay token o cuando el token vence en menos de 30 segundos (ExpiresAt), y guarda el token nuevo. WebApiOAuth2Authorizer calcula ExpiresAt a partir de expires_in; un token sin ExpiresAt no vence. Si el login falla no se guarda nada y el request sale sin encabezado de autorización; el siguiente request vuelve a intentar el login.

WebApiClientContext.Clone() copia BagContainer en lugar de compartirlo: use un clon por hilo cuando necesite consumir la misma API en paralelo.

SlackOptions

SendMessageAsync(mensaje, cancellationToken) no bloquea el hilo; SendMessage es la versión sincrónica. Ambos devuelven false si Slack no responde 200 tras MaxRetries intentos, y como máximo tardan MaxRetries × TimeoutSeconds más las pausas entre intentos.

Uso

Consumir un microservicio DS

using DS.Foundation.WebApi.Authorizer;
using DS.Foundation.WebApi.Client;
using DS.Foundation.WebApi.Security;
using DS.Foundation.WebApi.Surface.Contracts;

var context = new WebApiClientContext(timeout: 60)
{
    BaseUrl = "https://ventas.ejemplo.com",
    Authentication = new WebApiAuthentication { Username = usuario, Password = contraseña },
};
context.Authorizer = new WebApiBearerAuthorizer(context, "/api/identity/sign-in");

var client = new WebApiClient<ResponseContract<List<PedidoDto>>>(context);
ResponseContract<List<PedidoDto>> respuesta = client.SendAsJson("/api/pedidos", "GET");
if (respuesta.Success) { var pedidos = respuesta.Data; }

WebApiClient<T> es sincrónico y tiene puntos de extensión virtuales (DoBeforeExecute, DoAfterExecute, DoBeforeDeserialization, DoAfterDeserialization, FiltrarDatos, CurarDatos).

Llamada asincrónica

using DS.Foundation.WebApi.Consumer;

var consumer = new WebApiConsumer<ResponseContract<PedidoDto>>(context);
var pedido = await consumer.SendAsJsonAsync(new WebApiRequest("/api/pedidos/1", "GET"), cancellationToken);

WebApiConsumer<T> propaga las excepciones de red. La respuesta se deserializa con System.Text.Json sin opciones: los nombres de propiedad distinguen mayúsculas y minúsculas.

Contratos

• BaseResponseContract: Success, Message, Messages (UserMessageContract). ResponseContract<T> agrega Data.
• RequestContract<T>: Data más datos de la máquina y la sesión (BaseRequestContract).
• SearchContract (Id, Code, Text, Include*, Filters), ExtractContract (BatchSize, BatchNumber) y ErrorContract.
• response.FillWithAppEvent(appEvent) completa Message y Messages desde un AppEvent de DS.Foundation.

Registro de requests

context.Logger = new FileSystemWebApiLogger(@"C:\logs\webapi"); // un JSON por request: <ruta>/<tenant>/<yyyy_MM_dd>/<endpoint>/

MemoryWebApiLogger guarda los eventos en memoria (para depuración) y admite requests concurrentes.

Si el logger lanza una excepción, se ignora: un fallo de registro no hace fallar el request.

Errores frecuentes

Qué no hacer

• No usar FileSystemWebApiLogger ni MemoryWebApiLogger en producción con datos sensibles: guardan encabezados y cuerpos completos, incluido el encabezado Authorization y la contraseña enviada al autorizador.
• No reutilizar un WebApiClientContext durante mucho tiempo con WebApiClient: cada respuesta se agrega a BagContainer y la memoria crece sin límite.
• No crear un contexto por request: cada contexto crea un HttpClient nuevo.
• No llamar a los métodos sincrónicos (SendAsJson, Send, Execute, HttpDataFileUploader.Send) desde código asincrónico de ASP.NET Core: bloquean el hilo. Use SendAsJsonAsync.

Cambios

Ver CHANGELOG.md.