Zastępowanie za pomocą PUT
Część sekcji API REST ścieżki ASP.NET Core w Coddy. Lekcja 3 z 20.
PUT zastępuje element. Treść żądania zawiera cały nowy stan elementu, jest wysyłana na adres URL tego elementu, a pole pominięte w treści przyjmuje wartość domyślną. Dwukrotne wysłanie tego samego żądania PUT daje ten sam wynik, dlatego PUT jest idempotentne: klient może ponowić żądanie po przekroczeniu limitu czasu. POST nie jest idempotentne, ponieważ drugie żądanie POST dodaje drugi element.
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]);
});Id pochodzi ze ścieżki, nigdy z treści żądania, więc klient nie może zmienić identyfikatora produktu. FindIndex zwraca pozycję elementu na liście albo -1, gdy nic nie pasuje, a products[index] = ... zapisuje nową wersję na jego miejscu.
Wyzwanie
ŁatwyPozwól klientom zastępować zadanie.
- W pliku
Program.cszmapujPUT /api/tasks/{id:int}z parametramiint idiTaskInput input. Treść żądania ma taki sam format jak treść żądania POST. - Znajdź pozycję zadania za pomocą
tasks.FindIndex. Jeśli wynosi -1, zwróćResults.NotFound()i niczego nie dodawaj. - W przeciwnym razie zapisz
new TaskItem(id, input.Title, input.Done)na tej pozycji i zwróć je za pomocąResults.Ok. ŻądaniePUT /api/tasks/1z treścią{ "title": "Write the final brief", "done": true }zwraca kod 200 i:{ "id": 1, "title": "Write the final brief", "done": true }
Wypróbuj: naciśnij „Uruchom”, wybierz PUT, ścieżkę /api/tasks/1, powyższą treść i „Wyślij”: otrzymasz kod 200 i powyższe zadanie. Wyślij żądanie GET /api/tasks/1: pojawi się nowy tytuł. Wyślij żądanie PUT do /api/tasks/2 z treścią { "title": "Book the big room" }: zadanie 2 było wykonane, ale w treści zabrakło done, więc odpowiedź zawiera "done": false. Żądanie PUT do /api/tasks/99 zwraca kod 404.
Spróbuj swoich sił
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);
Wszystkie lekcje w sekcji API REST
1Zasoby i metody HTTP
Zasoby i adresy URLTworzenie za pomocą POST