Dettagli del problema
Fa parte della sezione API REST del percorso ASP.NET Core di Coddy. Lezione 8 di 20.
Un corpo 404 vuoto lascia il client a chiedersi cosa sia andato storto. I dettagli del problema (RFC 9457) sono il formato JSON standard per un errore, inviato con il tipo di contenuto application/problem+json. Le tue risposte 400 lo usano già. In un'API per gli ordini, tre righe danno a ogni errore lo stesso formato:
builder.Services.AddProblemDetails();
var app = builder.Build();
app.UseExceptionHandler();
app.UseStatusCodePages();Ora GET /api/orders/7 risponde con 404 se l'ordine non esiste, includendo:
{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
"title": "Not Found", "status": 404,
"traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00" }AddProblemDetails registra il servizio che genera il formato. UseStatusCodePages aggiunge un corpo con i dettagli del problema a ogni risposta di errore che ne è priva, che provenga da Results.NotFound() oppure da un percorso senza route. UseExceptionHandler trasforma un'eccezione non gestita in un problema 500. traceId è diverso per ogni richiesta e collega la risposta ai log del server.
Sfida
FacileDai agli errori del gestore delle attività un formato uniforme, così un client legge ogni errore sempre nello stesso modo.
- In
Program.cs, nella riga prima dibuilder.Build(), aggiungibuilder.Services.AddProblemDetails(); - Subito dopo
builder.Build(), aggiungiapp.UseExceptionHandler();e poiapp.UseStatusCodePages();, prima di qualsiasi endpoint.
Non cambiare nient'altro: i tuoi endpoint continuano a rispondere con Results.NotFound() e il middleware completa il corpo della risposta. GET /api/tasks/99 risponde quindi con 404, con il tipo di contenuto application/problem+json e:
{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5", "title": "Not Found", "status": 404, "traceId": "..." }Prova: premi Esegui e invia GET /api/tasks/99: ottieni il 404 qui sopra. Invia GET /api/projects, un percorso senza route: ottieni lo stesso formato. Invia con POST { "title": "" } a /api/tasks: il tuo 400 conserva errors e aggiunge traceId.
Provalo tu
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);
Questa lezione include un breve quiz. Inizia la lezione per rispondere e tenere traccia dei tuoi progressi.
Tutte le lezioni di API REST
2Validazione ed errori
Rifiutare input non validi