Menu
CoddyTech

Замена с помощью PUT

Часть раздела REST API путешествия по ASP.NET Core на Coddy. Урок 3 из 20.

PUT заменяет элемент. Тело содержит всё его новое состояние и отправляется на URL самого элемента, а поле, отсутствующее в теле, получает значение по умолчанию. Повторная отправка одного и того же PUT даёт тот же результат, поэтому PUT является идемпотентным: клиент может повторить запрос после тайм-аута. POST таким свойством не обладает, поскольку второй POST добавляет второй элемент.

app.MapPut("/api/products/{id:int}", (int id, ProductInput input) =>
{
    var index = products.FindIndex(p => p.Id == id);
    if (index == -1) return Results.NotFound();
    products[index] = new Product(id, input.Name, input.Price);
    return Results.Ok(products[index]);
});

Идентификатор берётся из пути, а не из тела, поэтому клиент не может перенести продукт на другой идентификатор. FindIndex возвращает позицию элемента в списке или -1, если совпадений нет, а products[index] = ... сохраняет новую версию на его месте.

challenge icon

Задание

Легко

Позвольте клиентам заменять задачу.

  1. В Program.cs добавьте маршрут PUT /api/tasks/{id:int} с параметрами int id и TaskInput input. Тело запроса имеет ту же структуру, что и тело POST-запроса.
  2. Найдите позицию задачи с помощью tasks.FindIndex. Если результат равен -1, ответьте Results.NotFound() и ничего не добавляйте.
  3. В противном случае сохраните new TaskItem(id, input.Title, input.Done) на этой позиции и верните его с помощью Results.Ok. На запрос PUT /api/tasks/1 с телом { "title": "Write the final brief", "done": true } возвращается код 200 и:
    { "id": 1, "title": "Write the final brief", "done": true }

Попробуйте: нажмите «Запустить», выберите PUT, укажите путь /api/tasks/1, добавьте тело запроса выше и нажмите «Отправить»: вы получите код 200 и задачу выше. Отправьте запрос GET /api/tasks/1: вы получите новое название. Отправьте PUT-запрос на /api/tasks/2 с телом { "title": "Book the big room" }: задача 2 была выполнена, но в теле не было поля done, поэтому в ответе будет "done": false. На запрос PUT к /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.Run();

record TaskItem(int Id, string Title, bool Done);
record TaskInput(string Title, bool Done);

Все уроки раздела REST API