Sumber Daya dan URL
Termasuk bagian REST API dalam perjalanan ASP.NET Core di Coddy. Pelajaran 1 dari 20.
Program lain memanggil API-mu, jadi URL-nya harus mudah ditebak. Sebagian besar API web mengikuti gaya yang disebut REST: setiap URL menyebutkan resource, sesuatu yang disimpan API, dan method HTTP menyatakan tindakan yang harus dilakukan.
GET /api/invoices the list of invoices
GET /api/invoices/7 invoice 7
POST /api/invoices add an invoice
DELETE /api/invoices/7 remove invoice 7Path berisi kata benda, tidak pernah kata kerja: dengan /api/getInvoice?id=7, setiap client harus mempelajari kata baru untuk setiap tindakan. Nama collection berbentuk jamak, dan satu item menggunakan path collection ditambah id-nya.
app.MapGet("/api/invoices/{id:int}", (int id) =>
{
var invoice = invoices.Find(i => i.Id == id);
return invoice is null ? Results.NotFound() : Results.Ok(invoice);
});{id:int} adalah parameter route dengan constraint: parameter ini hanya cocok dengan bilangan bulat, jadi /api/invoices/abc tidak cocok dengan route mana pun dan menghasilkan respons 404. Id yang tidak cocok dengan invoice mana pun juga menghasilkan respons 404 melalui Results.NotFound().
Tantangan
MudahDi bagian ini kamu membuat API pelacak tugas. API ini dimulai dengan tiga tugas dan GET /api/tasks, yang mengembalikan semuanya. Tugas-tugas ini adalah record TaskItem, karena .NET sudah memiliki tipe bernama Task. Tambahkan URL untuk satu tugas.
- Di
Program.cs, di bawahGET /api/tasks, petakanGET /api/tasks/{id:int}. - Temukan tugas yang
Id-nya sama denganidmenggunakantasks.Find, lalu kembalikan denganResults.Ok(task).GET /api/tasks/2mengembalikan:{ "id": 2, "title": "Book the meeting room", "done": true } - Jika tidak ada tugas dengan id tersebut, kembalikan
Results.NotFound(): status 404 dengan body kosong.
Coba: tekan Jalankan. Kolom tersebut mengirim GET /api/tasks dan menampilkan tiga tugas. Kirim GET /api/tasks/2: 200 dan tugas di atas. Kirim GET /api/tasks/99: 404. Kirim GET /api/tasks/abc: 404 juga, karena {id:int} hanya cocok dengan angka.
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),
};
app.MapGet("/api/tasks", () => tasks);
app.Run();
record TaskItem(int Id, string Title, bool Done);
Pelajaran ini berisi kuis singkat. Mulai pelajarannya untuk menjawab kuis dan melacak progresmu.
Semua pelajaran di REST API
1Sumber Daya dan Kata Kerja
Sumber Daya dan URLMembuat dengan POST