Menu
CoddyTech

Substituindo com PUT

Parte da seção APIs REST do Journey de ASP.NET Core da Coddy. Lição 3 de 20.

PUT substitui um item. O corpo é o novo estado completo do item, enviado para a URL do próprio item, e um campo omitido no corpo recebe seu valor padrão. Enviar o mesmo PUT duas vezes produz o mesmo resultado, então PUT é idempotente: um cliente pode tentar novamente após um tempo limite. POST não é, pois um segundo POST adiciona um segundo item.

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]);
});

O id vem do caminho, nunca do corpo, então um cliente não pode mover um produto para outro id. FindIndex retorna a posição do item na lista, ou -1 quando nada corresponde, e products[index] = ... armazena a nova versão no lugar da anterior.

challenge icon

Desafio

Fácil

Deixe os clientes substituir uma tarefa.

  1. Em Program.cs, mapeie PUT /api/tasks/{id:int} com os parâmetros int id e TaskInput input. O corpo tem o mesmo formato de um corpo POST.
  2. Encontre a posição da tarefa com tasks.FindIndex. Quando for -1, responda com Results.NotFound() e não adicione nada.
  3. Caso contrário, armazene new TaskItem(id, input.Title, input.Done) nessa posição e responda com Results.Ok. PUT /api/tasks/1 com { "title": "Write the final brief", "done": true } responde com 200 e:
    { "id": 1, "title": "Write the final brief", "done": true }

Experimente: pressione Executar, escolha PUT, caminho /api/tasks/1, o corpo acima e Enviar: 200 e a tarefa acima. Envie GET /api/tasks/1: o novo título. Envie PUT /api/tasks/2 com { "title": "Book the big room" }: a tarefa 2 estava concluída, mas o corpo omitiu done, então ela volta como "done": false. Uma solicitação PUT para /api/tasks/99 responde com 404.

Experimente você mesmo

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);

Todas as lições de APIs REST