リソースとURL
CoddyのASP.NET Coreジャーニー「REST API」セクションの一部。レッスン 1/20。
ほかのプログラムがあなたのAPIを呼び出すため、URLは推測しやすいものにする必要があります。ほとんどのWeb APIはRESTというスタイルに従っています。各URLは、APIが保存するものを表すリソースを指定し、HTTPメソッドがそのリソースに対する操作を示します。
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パスには名詞を使い、動詞は使いません。/api/getInvoice?id=7のようにすると、クライアントは操作ごとに新しい単語を覚えなければなりません。コレクションには複数形の名前を付け、個々の項目にはコレクションのパスにそのIDを加えたものを使います。
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}は制約付きのルートパラメーターです。整数にのみ一致するため、/api/invoices/abcはどのルートにも一致せず、404を返します。どの請求書にも一致しないIDも、Results.NotFound()によって404を返します。
チャレンジ
簡単このセクションでは、タスク追跡APIを作成します。最初に3つのタスクがあり、GET /api/tasksはそれらすべてを返します。タスクはTaskItemレコードです。.NETにはすでにTaskという型があるためです。1つのタスクのURLを追加しましょう。
Program.csで、GET /api/tasksの下にGET /api/tasks/{id:int}をマッピングします。tasks.Findを使って、Idがidと等しいタスクを見つけ、Results.Ok(task)で返します。GET /api/tasks/2は次を返します:{ "id": 2, "title": "Book the meeting room", "done": true }- そのidを持つタスクがない場合は、
Results.NotFound()を返します:ステータス404で、本文は空です。
試してみましょう:「実行」を押します。列がGET /api/tasksを送信し、3つのタスクを表示します。GET /api/tasks/2を送信します:200と上記のタスクが返ります。GET /api/tasks/99を送信します:404が返ります。GET /api/tasks/abcを送信します:これも404が返ります。{id:int}は数値にしか一致しないためです。
自分で試してみよう
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);
このレッスンには短いクイズがあります。レッスンを始めて解答し、進捗を記録しましょう。