POSTによる作成
CoddyのASP.NET Coreジャーニー「REST API」セクションの一部。レッスン 2/20。
POSTはコレクションに項目を追加します。新しいidはクライアントにはわからず、サーバーが決めるため、コレクションのURLにリクエストを送ります。応答は201 Createdで、新しい項目がJSONとして返され、新しい項目のURLを格納したLocationヘッダーが含まれます。ヘッダーとは、本文の前に送信される名前付きのテキスト行です。
var nextId = 8;
app.MapPost("/api/books", (BookInput input) =>
{
var book = new Book(nextId++, input.Title, input.Author);
books.Add(book);
return Results.Created($"/api/books/{book.Id}", book);
});レコードのパラメーターはJSON本文から読み取られ、プロパティがない場合はその型の既定値が使われます。カウンターを使って各本にidを割り当てます。Randomや時計を使ってidを作ってはいけません。同じリクエストには、同じidを返す必要があります。ここではそれが特に重要です。「送信」のたびに、新しいアプリで以前のリクエストがすべて再実行されるためです。
チャレンジ
簡単クライアントがタスクを追加できるようにしましょう。
Program.csで、タスクのリストの下にカウンターを追加します:var nextId = 4;- ファイルの末尾で、
TaskItemの下に、リクエスト本文の形を宣言します:record TaskInput(string Title, bool Done); TaskInput inputパラメーターを使ってPOST /api/tasksをマッピングします。nextId++、input.Title、input.DoneからTaskItemを作成し、tasksに追加して、Results.Created($"/api/tasks/{task.Id}", task)を返します。
本文{ "title": "Order new chairs" }を送ると、ステータスコード201とヘッダーLocation: /api/tasks/4、そして次の内容が返ります:
{ "id": 4, "title": "Order new chairs", "done": false }試してみましょう:「実行」を押し、POSTを選択して、パス/api/tasksはそのままにし、上記の本文を入力して「送信」します。ステータスコード201が返り、「Headers」タブにLocation: /api/tasks/4と表示されます。GET /api/tasks/4を送信すると、新しいタスクが返ります。同じPOSTをもう一度送信すると、ID 5が割り当てられます。これは、この列がその前に最初のPOSTを再生するためです。
自分で試してみよう
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.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.Run();
record TaskItem(int Id, string Title, bool Done);