Rejeter les entrées incorrectes
Fait partie de la section APIs REST du Journey ASP.NET Core de Coddy. Leçon 6 sur 20.
Un corps de requête peut être lié sans pour autant avoir de sens : un e-mail vide, un prix négatif. Renvoyez 400 Bad Request et indiquez ce qui ne va pas dans un format que les clients peuvent lire. Results.ValidationProblem prend un dictionnaire associant les noms de champs à des messages :
if (string.IsNullOrWhiteSpace(input.Email))
{
return Results.ValidationProblem(new Dictionary<string, string[]>
{
["email"] = ["Email is required."],
});
}Il renvoie le code 400 avec le type de contenu application/problem+json et ce corps de réponse :
{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"errors": { "email": ["Email is required."] } }Effectuez les vérifications avant de modifier quoi que ce soit, afin qu’une requête refusée laisse les données telles qu’elles étaient. Un corps de requête qui n’est pas du JSON valide n’atteint jamais votre lambda : ASP.NET Core renvoie le code 400.
Défi
FacileActuellement, POST /api/tasks avec { "title": "" } ajoute une tâche sans titre. Refuse-la.
- Au début de la lambda
POST /api/tasks, avantnextId++, vérifie le titre avecstring.IsNullOrWhiteSpace(input.Title). Cela détecte un titre manquant (null), un titre vide et un titre composé d’espaces. - En cas d’échec, renvoie
Results.ValidationProblemavec le champtitleet le messageTitle is required., afin que le corps contienne :"errors": { "title": ["Title is required."] } - Ajoute la même vérification au début de la lambda
PUT /api/tasks/{id:int}.
Essaie : appuie sur Run et envoie { "title": "" } en POST à /api/tasks : 400 et les erreurs ci-dessus. Envoie GET /api/tasks : toujours trois tâches. Envoie { "title": " ", "done": true } en PUT à /api/tasks/1 : 400, et la tâche 1 conserve son titre. Envoie { "title": "Order new chairs" } en POST : 201 avec l’id 4.
Essayez vous-même
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 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 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(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