Menu
CoddyTech

Detalles del problema

Parte de la sección API REST del Journey de ASP.NET Core de Coddy. Lección 8 de 20.

Un cuerpo 404 vacío deja al cliente sin saber qué ha salido mal. Los detalles del problema (RFC 9457) son el formato JSON estándar para un error, enviado con el tipo de contenido application/problem+json. Tus respuestas 400 ya lo usan. En una API de pedidos, tres líneas dan a todos los errores el mismo formato:

builder.Services.AddProblemDetails();
var app = builder.Build();

app.UseExceptionHandler();
app.UseStatusCodePages();

Ahora, GET /api/orders/7 para un pedido inexistente responde con un 404 que incluye:

{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
  "title": "Not Found", "status": 404,
  "traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00" }

AddProblemDetails registra el servicio que escribe el formato. UseStatusCodePages añade un cuerpo de problema a todas las respuestas de error que no lo tengan, ya sea de Results.NotFound() o de una ruta sin endpoint. UseExceptionHandler convierte una excepción no controlada en un problema 500. traceId es nuevo en cada solicitud; vincula la respuesta con los registros del servidor.

challenge icon

Desafío

Fácil

Dale a los errores del gestor de tareas un formato único, para que un cliente pueda leer todos los fallos de la misma manera.

  1. En Program.cs, en la línea anterior a builder.Build(), añade builder.Services.AddProblemDetails();
  2. Justo después de builder.Build(), añade app.UseExceptionHandler(); y después app.UseStatusCodePages();, antes de cualquier endpoint.

No cambies nada más: tus endpoints siguen respondiendo con Results.NotFound(), y el middleware completa el cuerpo. GET /api/tasks/99 responde entonces con 404, el tipo de contenido application/problem+json y:

{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5", "title": "Not Found", "status": 404, "traceId": "..." }

Pruébalo: pulsa Ejecutar y envía GET /api/tasks/99: obtendrás el 404 anterior. Envía GET /api/projects, una ruta sin endpoint: tendrá el mismo formato. Envía POST { "title": "" } a /api/tasks: tu respuesta 400 conserva errors y añade traceId.

Pruébalo tú mismo

using System.ComponentModel.DataAnnotations;

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

var tasks = new List<TaskItem>
{
    new(1, "Write the project brief", false),
    new(2, "Book the meeting room", true),
    new(3, "Send the invoice", false),
};
var nextId = 4;

app.MapGet("/api/tasks", () => tasks);

app.MapGet("/api/tasks/{id:int}", (int id) =>
{
    var task = tasks.Find(t => t.Id == id);
    return task is null ? Results.NotFound() : Results.Ok(task);
});

app.MapPost("/api/tasks", (TaskInput input) =>
{
    var errors = Validation.Errors(input);
    if (errors is not null) return Results.ValidationProblem(errors);
    var task = new TaskItem(nextId++, input.Title, input.Done);
    tasks.Add(task);
    return Results.Created($"/api/tasks/{task.Id}", task);
});

app.MapPut("/api/tasks/{id:int}", (int id, TaskInput input) =>
{
    var errors = Validation.Errors(input);
    if (errors is not null) return Results.ValidationProblem(errors);
    var index = tasks.FindIndex(t => t.Id == id);
    if (index == -1) return Results.NotFound();
    tasks[index] = new TaskItem(id, input.Title, input.Done);
    return Results.Ok(tasks[index]);
});

app.MapPatch("/api/tasks/{id:int}", (int id, TaskPatch patch) =>
{
    var index = tasks.FindIndex(t => t.Id == id);
    if (index == -1) return Results.NotFound();
    var task = tasks[index];
    tasks[index] = task with
    {
        Title = patch.Title ?? task.Title,
        Done = patch.Done ?? task.Done,
    };
    return Results.Ok(tasks[index]);
});

app.MapDelete("/api/tasks/{id:int}", (int id) =>
{
    var removed = tasks.RemoveAll(t => t.Id == id);
    return removed == 0 ? Results.NotFound() : Results.NoContent();
});

app.Run();

record TaskItem(int Id, string Title, bool Done);
record TaskInput(
    [property: Required(ErrorMessage = "Title is required."), StringLength(80)] string Title,
    bool Done);
record TaskPatch(string? Title, bool? Done);
quiz iconPonte a prueba

Esta lección incluye un breve cuestionario. Empieza la lección para responderlo y registrar tu progreso.

Todas las lecciones de API REST