Problemdetails
Teil des Abschnitts REST-APIs der ASP.NET Core-Journey von Coddy. Lektion 8 von 20.
Ein leerer 404-Antworttext lässt den Client raten, was schiefgelaufen ist. Problemdetails (RFC 9457) ist das standardisierte JSON-Format für einen Fehler, das mit dem Inhaltstyp application/problem+json gesendet wird. Deine 400-Antworten verwenden es bereits. In einer Orders-API sorgen drei Zeilen dafür, dass alle Fehler dasselbe Format haben:
builder.Services.AddProblemDetails();
var app = builder.Build();
app.UseExceptionHandler();
app.UseStatusCodePages();Nun liefert GET /api/orders/7 für eine nicht vorhandene Bestellung eine 404-Antwort mit:
{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
"title": "Not Found", "status": 404,
"traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00" }AddProblemDetails registriert den Dienst, der das Format schreibt. UseStatusCodePages ergänzt jede Fehlerantwort, die noch keinen Antworttext hat, um einen Problemtext – sei es bei deinem Results.NotFound() oder bei einem Pfad ohne Route. UseExceptionHandler wandelt eine nicht abgefangene Ausnahme in einen 500-Problemtext um. traceId ist bei jeder Anfrage neu und verknüpft die Antwort mit den Serverprotokollen.
Aufgabe
EinfachGib den Fehlern des Aufgaben-Trackers ein einheitliches Format, damit ein Client jeden Fehler auf dieselbe Weise auslesen kann.
- Füge in
Program.csin der Zeile vorbuilder.Build()builder.Services.AddProblemDetails();hinzu. - Füge direkt nach
builder.Build()und vor allen Endpunktenapp.UseExceptionHandler();und dannapp.UseStatusCodePages();hinzu.
Ändere sonst nichts: Deine Endpunkte antworten weiterhin mit Results.NotFound(), und die Middleware füllt den Antworttext aus. GET /api/tasks/99 antwortet dann mit 404, dem Inhaltstyp application/problem+json und:
{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5", "title": "Not Found", "status": 404, "traceId": "..." }Probier es aus: Drücke auf „Ausführen“ und sende GET /api/tasks/99: den obigen 404-Fehler. Sende GET /api/projects, einen Pfad ohne Route: dasselbe Format. Sende per POST { "title": "" } an /api/tasks: Dein 400-Fehler behält sein errors-Feld und erhält ein traceId.
Probier es selbst
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);
Diese Lektion enthält ein kurzes Quiz. Starte die Lektion, um es zu beantworten und deinen Fortschritt zu speichern.