Détails du problème
Fait partie de la section APIs REST du Journey ASP.NET Core de Coddy. Leçon 8 sur 20.
Un corps 404 vide laisse le client deviner ce qui s’est mal passé. Les détails du problème (RFC 9457) constituent le format JSON standard pour une erreur, envoyé avec le type de contenu application/problem+json. Vos réponses 400 l’utilisent déjà. Dans une API de commandes, trois lignes donnent à chaque erreur le même format :
builder.Services.AddProblemDetails();
var app = builder.Build();
app.UseExceptionHandler();
app.UseStatusCodePages();Désormais, GET /api/orders/7 répond 404 si la commande est introuvable, avec :
{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
"title": "Not Found", "status": 404,
"traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00" }AddProblemDetails enregistre le service qui génère ce format. UseStatusCodePages fournit un corps de problème à chaque réponse d’erreur qui n’en a pas, qu’elle provienne de votre Results.NotFound() ou d’un chemin sans route. UseExceptionHandler transforme une exception non interceptée en problème 500. traceId est nouveau à chaque requête ; il relie la réponse aux journaux du serveur.
Défi
FacileDonne aux erreurs du gestionnaire de tâches une forme unique, afin que le client lise chaque échec de la même manière.
- Dans
Program.cs, à la ligne précédantbuilder.Build(), ajoutebuilder.Services.AddProblemDetails(); - Juste après
builder.Build(), ajouteapp.UseExceptionHandler();, puisapp.UseStatusCodePages();, avant tout point de terminaison.
Ne change rien d’autre : tes points de terminaison continuent de répondre avec Results.NotFound(), et le middleware remplit le corps de la réponse. GET /api/tasks/99 répond alors avec le code 404, le type de contenu application/problem+json et :
{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5", "title": "Not Found", "status": 404, "traceId": "..." }Essaie : appuie sur « Exécuter » et envoie GET /api/tasks/99 : tu obtiens le code 404 ci-dessus. Envoie GET /api/projects, un chemin sans route : tu obtiens la même forme. Envoie { "title": "" } à /api/tasks avec une requête POST : ta réponse 400 conserve ses errors et gagne un traceId.
Essayez vous-même
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);
Cette leçon comprend un petit quiz. Commencez la leçon pour y répondre et suivre votre progression.
Toutes les leçons de APIs REST
2Validation et erreurs
Rejeter les entrées incorrectes