Menu
CoddyTech

问题详情

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

空的 404 响应正文会让客户端猜不出出了什么问题。问题详情(RFC 9457)是错误响应的标准 JSON 格式,使用内容类型 application/problem+json 发送。你的 400 响应已经使用了这种格式。在订单 API 中,只需三行代码,就能让每个错误使用相同的格式:

builder.Services.AddProblemDetails();
var app = builder.Build();

app.UseExceptionHandler();
app.UseStatusCodePages();

现在,访问不存在的订单时,GET /api/orders/7 会返回 404,响应内容如下:

{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
  "title": "Not Found", "status": 404,
  "traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00" }

AddProblemDetails 会注册用于写入这种格式的服务。UseStatusCodePages 会为所有尚无问题正文的错误响应添加问题正文,这些响应可能来自你的 Results.NotFound(),也可能来自没有匹配路由的路径。UseExceptionHandler 会将未处理的异常转换为 500 问题响应。每个请求都会生成一个新的 traceId,它能将响应与服务器日志关联起来。

challenge icon

挑战

简单

让任务跟踪器的错误采用统一格式,这样客户端就能用相同的方式读取每种失败响应。

  1. 在 Program.cs 中,在 builder.Build() 上一行添加 builder.Services.AddProblemDetails();
  2. 紧接着 builder.Build() 后面,在任何端点之前添加 app.UseExceptionHandler();,然后添加 app.UseStatusCodePages();

不要改动其他内容:你的端点仍然返回 Results.NotFound(),中间件会补上响应正文。接着,GET /api/tasks/99 会返回状态码 404,内容类型为 application/problem+json,并包含:

{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5", "title": "Not Found", "status": 404, "traceId": "..." }

试试看:按下“运行”,并发送 GET /api/tasks/99:返回上面的 404。发送 GET /api/projects,这是一个没有对应路由的路径:返回相同格式。向 /api/tasks 发送 POST 请求,内容为 { "title": "" }:你的 400 响应会保留 errors,并增加 traceId。

亲手试试

using System.ComponentModel.DataAnnotations;

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 errors = Validation.Errors(input);
    if (errors is not null) return Results.ValidationProblem(errors);
    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 errors = Validation.Errors(input);
    if (errors is not null) return Results.ValidationProblem(errors);
    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(
    [property: Required(ErrorMessage = "Title is required."), StringLength(80)] string Title,
    bool Done);
record TaskPatch(string? Title, bool? Done);
quiz icon自我测试

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

REST API中的所有课