PromericaGT.GTHeadersMiddleware 0.2.1

GTHeaderMiddleware

Contenido

• GTHeaderMiddleware
• Contenido
  • Descripción
    • Características
    • Encabezados de entrada
    • Encabezados de salida
  • Instalación
  • Uso
  • Manejo de errores
  • Actualizaciones

Descripción

Librería que se encarga de validar y agregar los encabezados "headers" en las peticiones HTTP, para los distintos proyectos ASP.NET.

Características

• Validación de encabezados HTTP de entrada y salida.
• Configuración de encabezados personalizados.
• Facil integración en proyectos ASP.NET Core.

Encabezados de entrada

Los encabezados que valida, por defecto, son los siguientes:

ℹ️ Soporta cabeceras adicionales para casos de uso específicos (consultar documentación interna).

Encabezados de salida

Los encabezados que agrega, por defecto, son los siguientes:

Instalación

1. Agrega la librería a tu proyecto, puedes hacerlo a través de NuGet Package Manager Console ejecutando el siguiente comando:

dotnet add package GTHeaderMiddleware

• Si es una referencia local: Agrega el proyecto de la librería a tu solución y referencia el proyecto en tu aplicación.

2. Asegúrate de que tu proyecto use .NET 8 o una versión compatible con la librería.

Uso

Para la integración de la librería en el proyecto, se debe agregar el middleware en la clase Program.cs del proyecto. A continuación se muestra un ejemplo de cómo hacerlo:

using GTHeaderMiddleware.Exceptions;
using GTHeaderMiddleware.Extensions;
using GTHeaderMiddleware.Interfaces;

var builder = WebApplication.CreateBuilder(args);

#region Configuración de los encabezados de respuesta
builder.Services.AddHeaderLibrary(config =>
{
    config.GenerateEsbMessageId = ctx => Guid.NewGuid().ToString();
});
#endregion Configuración de los encabezados de respuesta

var app = builder.Build();

#region Manejo de excepciones para encabezados
// Agregar el middleware de encabezados.
app.Use(async (context, next) =>
{
    try
    {
        await next(context);
    }
    catch (Exception ex)
    {
        var serviceProvider = context.RequestServices;
        var headerMapper = context.RequestServices.GetRequiredService<IHeaderMapper<GTHeaderMiddleware.Models.RequestHeaders>>();
        // Manejo de errores personalizado.
        context.Response.Clear();
        context.Response.ContentType = "application/json";

        if (ex is HeaderValidationException headerEx)
        {
            var error = new
            {
                message = "Error de validación de encabezados" ,
                detail = headerEx.Errors
            };
            context.Response.StatusCode = StatusCodes.Status400BadRequest;
            await context.Response.WriteAsJsonAsync(error);
        }
        else
        {
            var error = new
            {
                message = ex.Message ?? "Error interno del servidor",
                detail = ex.InnerException?.Message ?? string.Empty
            };
            context.Response.StatusCode = StatusCodes.Status500InternalServerError;
            await context.Response.WriteAsJsonAsync(error);
        }
    }
});

app.UseHeaderLibrary<GTHeaderMiddleware.Models.RequestHeaders>();
#endregion Manejo de excepciones para encabezados

app.UseHttpsRedirection();
app.UseAuthorization();
app.MapControllers();

app.Run();

Manejo de errores

El middleware también permite manejar errores de manera personalizada. Puedes definir la lógica de manejo de errores dentro del bloque async (context, exception) => { ... } al agregar el middleware.

Actualizaciones

Para mantener la librería actualizada, puedes ejecutar el siguiente comando en la consola de NuGet Package Manager:

dotnet update package GTHeaderMiddleware

Esto actualizará la librería a la última versión disponible en NuGet.