Menu
CoddyTech

Problem Details

CoddyのASP.NET Coreジャーニー「REST API」セクションの一部。レッスン 8/20。

空の404レスポンス本文では、何が問題だったのかをクライアントが推測するしかありません。Problem details(RFC 9457)は、エラーを表す標準的なJSON形式で、コンテンツタイプ application/problem+json とともに送信されます。400エラーでは、すでにこれが使われています。注文APIでは、次の3行で、すべてのエラーを同じ形式にできます。

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は、コンテンツタイプapplication/problem+jsonで404と次の内容を返します。

{ "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を送信すると、同じ形式で返ります。{ "title": "" }を/api/tasksにPOSTします。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のすべてのレッスン