Częściowe aktualizacje za pomocą PATCH
Część sekcji API REST ścieżki ASP.NET Core w Coddy. Lekcja 4 z 20.
PATCH zmienia tylko pola wysłane w treści żądania. Aby odróżnić pole pominięte od pola, któremu przypisano wartość, ustaw wszystkie właściwości rekordu aktualizacji jako dopuszczające wartość null: pominięte pole jest wiązane z null.
record ProfilePatch(string? Name, string? City);
profiles[index] = profile with
{
Name = patch.Name ?? profile.Name,
City = patch.City ?? profile.City,
};with kopiuje rekord i zmienia wymienione przez ciebie właściwości. ?? zachowuje starą wartość, gdy aktualizacja zawiera null. bool? działa tak samo: false to wartość przesłana przez klienta, a null oznacza, że klient niczego nie przesłał. Dlatego { "city": "Lyon" } przenosi profil i zachowuje jego nazwę.
Wyzwanie
ŁatwyPozwól klientom zmieniać jedno pole zadania, na przykład oznaczać je jako wykonane, bez ponownego wysyłania tytułu.
- Na dole pliku
Program.cszadeklarujrecord TaskPatch(string? Title, bool? Done); - Mapuj
PATCH /api/tasks/{id:int}z parametramiint idiTaskPatch patch. ZwróćResults.NotFound(), gdy nie ma zadania o tym identyfikatorze. - W przeciwnym razie zapisz kopię zadania utworzoną za pomocą
with, w której każda właściwość przyjmuje wartość z patcha albo zachowuje własną wartość zadania, jeśli patch ma wartośćnull. Zwróć zmienione zadanie za pomocąResults.Ok.
PATCH /api/tasks/1 z { "done": true } zwraca kod 200 i:
{ "id": 1, "title": "Write the project brief", "done": true }Wypróbuj: naciśnij Uruchom, wybierz PATCH, ścieżkę /api/tasks/1, treść { "done": true } i naciśnij Wyślij: otrzymasz odpowiedź powyżej, a tytuł zostanie zachowany. Wyślij PATCH do /api/tasks/2 z treścią { "title": "Book the big room" }: pojawi się nowy tytuł, a "done": true pozostanie bez zmian. PATCH /api/tasks/99 zwraca kod 404.
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.Run();
record TaskItem(int Id, string Title, bool Done);
record TaskInput(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
1Zasoby i metody HTTP
Zasoby i adresy URLTworzenie za pomocą POST