Menu
CoddyTech

Ersetzen mit PUT

Teil des Abschnitts REST-APIs der ASP.NET Core-Journey von Coddy. Lektion 3 von 20.

PUT ersetzt ein Element. Der Body enthält den vollständigen neuen Zustand des Elements und wird an die URL des Elements selbst gesendet. Ein Feld, das im Body fehlt, erhält seinen Standardwert. Zweimaliges Senden desselben PUT ergibt dasselbe Ergebnis, daher ist PUT idempotent: Ein Client kann den Vorgang nach einer Zeitüberschreitung wiederholen. Bei POST ist das nicht der Fall, da ein zweiter POST ein zweites Element hinzufügt.

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

Die ID stammt aus dem Pfad, niemals aus dem Body. Daher kann ein Client einem Produkt keine andere ID zuweisen. FindIndex gibt die Position des Elements in der Liste zurück oder -1, wenn nichts übereinstimmt, und products[index] = ... speichert die neue Version an dieser Stelle.

challenge icon

Aufgabe

Einfach

Ermögliche Clients, eine Aufgabe zu ersetzen.

  1. Bilde in Program.cs PUT /api/tasks/{id:int} mit einem Parameter int id und einem Parameter TaskInput input ab. Der Request-Body hat dieselbe Form wie ein POST-Body.
  2. Ermittle die Position der Aufgabe mit tasks.FindIndex. Wenn sie -1 ist, antworte mit Results.NotFound() und füge nichts hinzu.
  3. Speichere andernfalls new TaskItem(id, input.Title, input.Done) an dieser Position und antworte mit Results.Ok. PUT /api/tasks/1 mit { "title": "Write the final brief", "done": true } antwortet mit 200 und:
    { "id": 1, "title": "Write the final brief", "done": true }

Probier es aus: Drücke „Ausführen“, wähle PUT, den Pfad /api/tasks/1, den obigen Body und „Senden“: 200 und die obige Aufgabe. Sende GET /api/tasks/1: den neuen Titel. Sende PUT /api/tasks/2 mit { "title": "Book the big room" }: Aufgabe 2 war erledigt, aber im Body fehlte done, daher kommt "done": false zurück. Ein PUT an /api/tasks/99 antwortet mit 404.

Probier es selbst

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

Alle Lektionen in REST-APIs