Odrzucanie nieprawidłowych danych wejściowych
Część sekcji API REST ścieżki ASP.NET Core w Coddy. Lekcja 6 z 20.
Treść żądania może zostać powiązana, a mimo to nie mieć sensu: pusty adres e-mail, ujemna cena. Zwróć 400 Bad Request i opisz problem w formacie, który klienci mogą odczytać. Results.ValidationProblem przyjmuje słownik mapujący nazwy pól na komunikaty:
if (string.IsNullOrWhiteSpace(input.Email))
{
return Results.ValidationProblem(new Dictionary<string, string[]>
{
["email"] = ["Email is required."],
});
}Zwraca odpowiedź 400 z typem zawartości application/problem+json i następującą treścią:
{ "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."] } }Sprawdź dane, zanim cokolwiek zmienisz, aby odrzucone żądanie nie zmieniło danych. Treść żądania, która nie jest prawidłowym JSON-em, nigdy nie dotrze do Twojej lambdy: ASP.NET Core zwróci dla niej odpowiedź 400.
Wyzwanie
ŁatwyObecnie POST /api/tasks z { "title": "" } dodaje zadanie bez tytułu. Odrzuć takie żądanie.
- Na początku lambdy
POST /api/tasks, przednextId++, sprawdź tytuł za pomocąstring.IsNullOrWhiteSpace(input.Title). To wykrywa brakujący tytuł (null), pusty tytuł oraz tytuł składający się ze spacji. - Gdy warunek jest spełniony, zwróć
Results.ValidationProblemz polemtitlei komunikatemTitle is required., aby treść odpowiedzi zawierała:"errors": { "title": ["Title is required."] } - Dodaj takie samo sprawdzenie na początku lambdy
PUT /api/tasks/{id:int}.
Wypróbuj: naciśnij „Uruchom” i wyślij żądanie POST { "title": "" } do /api/tasks: otrzymasz 400 i powyższe błędy. Wyślij żądanie GET /api/tasks: nadal będą trzy zadania. Wyślij żądanie PUT { "title": " ", "done": true } do /api/tasks/1: otrzymasz 400, a zadanie 1 zachowa swój tytuł. Wyślij żądanie POST { "title": "Order new chairs" }: otrzymasz 201 z identyfikatorem 4.
Spróbuj swoich sił
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);
Ta lekcja zawiera krótki quiz. Zacznij lekcję, żeby na niego odpowiedzieć i śledzić swoje postępy.
Wszystkie lekcje w sekcji API REST
2Walidacja i błędy
Odrzucanie nieprawidłowych danych wejściowych