Menu
CoddyTech

Tài nguyên và URL

Thuộc phần REST API trong hành trình ASP.NET Core của Coddy. Bài học 1 trên 20.

Các chương trình khác gọi API của bạn, vì vậy URL cần dễ đoán. Hầu hết API web tuân theo một kiểu gọi là REST: mỗi URL đặt tên cho một tài nguyên, tức là thứ mà API lưu trữ, còn phương thức HTTP cho biết cần làm gì với tài nguyên đó.

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 7

Đường dẫn chứa danh từ, không chứa động từ: với /api/getInvoice?id=7, mỗi client phải học một từ mới cho từng hành động. Tên của bộ sưu tập ở dạng số nhiều, còn một mục là đường dẫn của bộ sưu tập cộng với id của mục đó.

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} là tham số tuyến đường có ràng buộc: chỉ khớp với số nguyên, nên /api/invoices/abc không khớp với tuyến đường nào và trả về 404. Id không khớp với hóa đơn nào cũng trả về 404 thông qua Results.NotFound().

challenge icon

Thử thách

Dễ

Trong phần này, bạn xây dựng một API theo dõi công việc. API bắt đầu với ba công việc và GET /api/tasks, trả về tất cả công việc. Các công việc là bản ghi (record) TaskItem, vì .NET đã có kiểu Task. Hãy thêm URL cho một công việc.

  1. Trong Program.cs, bên dưới GET /api/tasks, ánh xạ GET /api/tasks/{id:int}.
  2. Tìm công việc có Id bằng id bằng tasks.Find, rồi trả về công việc đó với Results.Ok(task). GET /api/tasks/2 trả về:
    { "id": 2, "title": "Book the meeting room", "done": true }
  3. Khi không có công việc nào mang id đó, trả về Results.NotFound(): mã trạng thái 404 với phần thân rỗng.

Thử nhé: nhấn Chạy. Cột này gửi GET /api/tasks và hiển thị ba công việc. Gửi GET /api/tasks/2: 200 và công việc ở trên. Gửi GET /api/tasks/99: 404. Gửi GET /api/tasks/abc: cũng trả về 404, vì {id:int} chỉ khớp với số.

Tự làm thử

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);
quiz iconTự kiểm tra

Bài học này có một bài trắc nghiệm ngắn. Bắt đầu bài học để trả lời và theo dõi tiến độ.

Tất cả bài học trong REST API