Menu
CoddyTech

拒绝无效输入

本课属于 Coddy ASP.NET Core 学习旅程的“REST API”单元。第 6 课,共 20 课。

请求体可以成功绑定,但内容仍然不合理:邮箱为空,价格为负数。返回 400 Bad Request,并用客户端可以读取的格式说明问题。Results.ValidationProblem 接收一个字典,其中键是字段名,值是错误消息:

if (string.IsNullOrWhiteSpace(input.Email))
{
    return Results.ValidationProblem(new Dictionary<string, string[]>
    {
        ["email"] = ["Email is required."],
    });
}

它会以 application/problem+json 作为内容类型,并返回 400,响应体如下:

{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": { "email": ["Email is required."] } }

在进行任何更改之前先检查请求,这样被拒绝的请求就不会改变数据。格式无效的 JSON 请求体不会到达你的 lambda:ASP.NET Core 会对此返回 400。

challenge icon

挑战

简单

现在,使用 POST /api/tasks 和 { "title": "" } 会添加一个没有标题的任务。拒绝这种请求。

  1. 在 POST /api/tasks lambda 的开头、nextId++ 之前,使用 string.IsNullOrWhiteSpace(input.Title) 检查标题。它可以捕获缺少标题(null)、标题为空以及标题只有空格的情况。
  2. 检查失败时,返回 Results.ValidationProblem,字段为 title,消息为 Title is required.,这样响应正文就会包含:
    "errors": { "title": ["Title is required."] }
  3. 在 PUT /api/tasks/{id:int} lambda 的开头添加相同的检查。

试试看:按“运行”,然后向 /api/tasks 发送 POST 请求,内容为 { "title": "" }:返回 400 和上面的错误。发送 GET /api/tasks:仍有 3 个任务。向 /api/tasks/1 发送 PUT 请求,内容为 { "title": " ", "done": true }:返回 400,任务 1 保留原来的标题。发送 POST 请求,内容为 { "title": "Order new chairs" }:返回 201,id 为 4。

亲手试试

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),
};
var nextId = 4;

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.MapPost("/api/tasks", (TaskInput input) =>
{
    var task = new TaskItem(nextId++, input.Title, input.Done);
    tasks.Add(task);
    return Results.Created($"/api/tasks/{task.Id}", task);
});

app.MapPut("/api/tasks/{id:int}", (int id, TaskInput input) =>
{
    var index = tasks.FindIndex(t => t.Id == id);
    if (index == -1) return Results.NotFound();
    tasks[index] = new TaskItem(id, input.Title, input.Done);
    return Results.Ok(tasks[index]);
});

app.MapPatch("/api/tasks/{id:int}", (int id, TaskPatch patch) =>
{
    var index = tasks.FindIndex(t => t.Id == id);
    if (index == -1) return Results.NotFound();
    var task = tasks[index];
    tasks[index] = task with
    {
        Title = patch.Title ?? task.Title,
        Done = patch.Done ?? task.Done,
    };
    return Results.Ok(tasks[index]);
});

app.MapDelete("/api/tasks/{id:int}", (int id) =>
{
    var removed = tasks.RemoveAll(t => t.Id == id);
    return removed == 0 ? Results.NotFound() : Results.NoContent();
});

app.Run();

record TaskItem(int Id, string Title, bool Done);
record TaskInput(string Title, bool Done);
record TaskPatch(string? Title, bool? Done);
quiz icon自我测试

这节课包含一个小测验。开始学习即可作答,并记录你的进度。

REST API中的所有课