Menu
CoddyTech

Remplacer avec PUT

Fait partie de la section APIs REST du Journey ASP.NET Core de Coddy. Leçon 3 sur 20.

PUT remplace un élément. Le corps correspond au nouvel état complet de l’élément, envoyé à l’URL propre à celui-ci, et tout champ omis dans le corps prend sa valeur par défaut. Envoyer deux fois le même PUT donne le même résultat : PUT est donc idempotent ; un client peut le réessayer après un délai d’attente. Ce n’est pas le cas de POST, car un deuxième POST ajoute un deuxième élément.

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

L’id vient du chemin, jamais du corps : un client ne peut donc pas attribuer un autre id à un produit. FindIndex renvoie la position de l’élément dans la liste, ou -1 si aucun élément ne correspond, et products[index] = ... enregistre la nouvelle version à sa place.

challenge icon

Défi

Facile

Permets aux clients de remplacer une tâche.

  1. Dans Program.cs, associe PUT /api/tasks/{id:int} à des paramètres int id et TaskInput input. Le corps a la même forme qu'un corps de requête POST.
  2. Trouve la position de la tâche avec tasks.FindIndex. Si elle vaut -1, réponds Results.NotFound() et n'ajoute rien.
  3. Sinon, stocke new TaskItem(id, input.Title, input.Done) à cette position et renvoie-la avec Results.Ok. PUT /api/tasks/1 avec { "title": "Write the final brief", "done": true } renvoie 200 et :
    { "id": 1, "title": "Write the final brief", "done": true }

Essaie : appuie sur Exécuter, choisis PUT, indique le chemin /api/tasks/1, le corps ci-dessus, puis appuie sur Envoyer : tu obtiens 200 et la tâche ci-dessus. Envoie GET /api/tasks/1 : le nouveau titre. Envoie PUT /api/tasks/2 avec { "title": "Book the big room" } : la tâche 2 était terminée, mais le corps ne contenait pas done, donc la réponse indique "done": false. Une requête PUT vers /api/tasks/99 renvoie 404.

Essayez vous-même

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

Toutes les leçons de APIs REST