Mengganti dengan PUT
Termasuk bagian REST API dalam perjalanan ASP.NET Core di Coddy. Pelajaran 3 dari 20.
PUT mengganti sebuah item. Body berisi seluruh keadaan baru item, dikirim ke URL item itu sendiri, dan field yang tidak dicantumkan dalam body akan mendapat nilai default. Mengirim PUT yang sama dua kali memberikan hasil yang sama, jadi PUT bersifat idempoten: client dapat mencoba mengirimnya lagi setelah timeout. POST tidak demikian, karena POST kedua menambahkan item kedua.
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 berasal dari path, bukan dari body, jadi client tidak dapat memindahkan produk ke id lain. FindIndex mengembalikan posisi item di dalam list, atau -1 jika tidak ada yang cocok, dan products[index] = ... menyimpan versi baru di tempatnya.
Tantangan
MudahBiarkan client mengganti task.
- Di
Program.cs, petakanPUT /api/tasks/{id:int}dengan parameterint iddanTaskInput input. Bentuk body-nya sama dengan body POST. - Cari posisi task dengan
tasks.FindIndex. Jika nilainya -1, kembalikanResults.NotFound()dan jangan tambahkan apa pun. - Jika tidak, simpan
new TaskItem(id, input.Title, input.Done)pada posisi tersebut dan kembalikan denganResults.Ok.PUT /api/tasks/1dengan{ "title": "Write the final brief", "done": true }mengembalikan 200 dan:{ "id": 1, "title": "Write the final brief", "done": true }
Coba: tekan Jalankan, pilih PUT, path /api/tasks/1, body di atas, lalu Kirim: hasilnya 200 dan task di atas. Kirim GET /api/tasks/1: judul yang baru. Kirim PUT /api/tasks/2 dengan { "title": "Book the big room" }: task 2 sudah selesai, tetapi body tidak menyertakan done, jadi hasilnya "done": false. PUT ke /api/tasks/99 mengembalikan 404.
Coba sendiri
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);
Semua pelajaran di REST API
1Sumber Daya dan Kata Kerja
Sumber Daya dan URLMembuat dengan POST