使用 POST 创建
本课属于 Coddy ASP.NET Core 学习旅程的“REST API”单元。第 2 课,共 20 课。
POST 会向集合中添加一个项目。请求会发送到集合的 URL,因为客户端不知道新项目的 id:由服务器来决定。响应是 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);