Частичное обновление с помощью PATCH
Часть раздела REST API путешествия по ASP.NET Core на Coddy. Урок 4 из 20.
PATCH изменяет только поля, которые отправляет тело запроса. Чтобы отличить поле, которое не было передано, от поля, которому присвоили значение, сделай каждое свойство записи патча допускающим значение null: отсутствующее поле привязывается к null.
record ProfilePatch(string? Name, string? City);
profiles[index] = profile with
{
Name = patch.Name ?? profile.Name,
City = patch.City ?? profile.City,
};with копирует запись и изменяет перечисленные тобой свойства. ?? сохраняет старое значение, если патч содержит null. bool? работает так же: false — это значение, отправленное клиентом, а null означает, что клиент ничего не отправил. Поэтому { "city": "Lyon" } меняет город профиля, сохраняя его имя.
Задание
ЛегкоПозвольте клиентам изменять одно поле задачи, например отмечать её как выполненную, не отправляя заголовок повторно.
- В конце
Program.csобъявитеrecord TaskPatch(string? Title, bool? Done); - Создайте маршрут для
PATCH /api/tasks/{id:int}с параметрамиint idиTaskPatch patch. ВозвращайтеResults.NotFound(), если задачи с таким идентификатором нет. - В противном случае сохраните копию задачи, созданную с помощью
with, где для каждого свойства используется значение из patch или сохраняется значение самой задачи, если в patch указаноnull. Верните изменённую задачу с помощьюResults.Ok.
Запрос PATCH /api/tasks/1 с { "done": true } возвращает код 200 и:
{ "id": 1, "title": "Write the project brief", "done": true }Попробуйте: нажмите «Запустить», выберите PATCH, укажите путь /api/tasks/1, тело { "done": true } и нажмите «Отправить»: ответ будет таким, как выше, а заголовок останется прежним. Отправьте PATCH-запрос к /api/tasks/2 с телом { "title": "Book the big room" }: заголовок изменится, а "done": true останется. Запрос PATCH к /api/tasks/99 возвращает код 404.
Попробуйте сами
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);
В этом уроке есть небольшой тест. Начните урок, чтобы ответить на вопросы и сохранить прогресс.
Все уроки раздела REST API
1Ресурсы и HTTP-методы
Ресурсы и URLСоздание с помощью POST