Menu
CoddyTech

Detalhes do problema

Parte da seção APIs REST do Journey de ASP.NET Core da Coddy. Lição 8 de 20.

Um corpo 404 vazio deixa o cliente sem saber o que deu errado. Detalhes do problema (RFC 9457) é o formato JSON padrão para um erro, enviado com o tipo de conteúdo application/problem+json. Seus erros 400 já o utilizam. Em uma API de pedidos, três linhas dão a todos os erros o mesmo formato:

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

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

Agora, GET /api/orders/7 para um pedido inexistente responde com 404 e:

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

AddProblemDetails registra o serviço que escreve esse formato. UseStatusCodePages fornece um corpo de problema para toda resposta de erro que não tenha um, seja de Results.NotFound() ou de um caminho sem rota. UseExceptionHandler transforma uma exceção não tratada em um problema 500. traceId é novo em cada solicitação; ele vincula a resposta aos logs do servidor.

challenge icon

Desafio

Fácil

Dê aos erros do rastreador de tarefas um formato único, para que um cliente leia todas as falhas da mesma maneira.

  1. Em Program.cs, na linha antes de builder.Build(), adicione builder.Services.AddProblemDetails();
  2. Logo após builder.Build(), adicione app.UseExceptionHandler(); e depois app.UseStatusCodePages();, antes de qualquer endpoint.

Não altere mais nada: seus endpoints continuam respondendo com Results.NotFound(), e o middleware preenche o corpo. GET /api/tasks/99 então responde com 404 e o tipo de conteúdo application/problem+json e:

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

Experimente: pressione Run e envie GET /api/tasks/99: o 404 acima. Envie GET /api/projects, um caminho sem rota: o mesmo formato. Envie POST { "title": "" } para /api/tasks: seu 400 mantém errors e ganha um traceId.

Experimente você mesmo

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 iconTeste seus conhecimentos

Esta lição inclui um quiz rápido. Comece a lição para respondê-lo e acompanhar seu progresso.

Todas as lições de APIs REST