不正な入力を拒否する
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ではないボディはラムダに到達しません。ASP.NET Coreが400を返します。
チャレンジ
簡単現時点では、POST /api/tasks に { "title": "" } を送ると、タイトルのないタスクが追加されます。これを拒否しましょう。
POST /api/tasksのラムダの先頭で、nextId++の前に、string.IsNullOrWhiteSpace(input.Title)でタイトルを確認します。これにより、タイトルがない場合(null)、空の場合、空白だけの場合を検出できます。- 条件に該当した場合は、フィールド
titleとメッセージTitle is required.を指定してResults.ValidationProblemを返し、本文が次のようになるようにします:"errors": { "title": ["Title is required."] } PUT /api/tasks/{id:int}のラムダの先頭にも、同じ確認を追加します。
試してみましょう:「実行」を押して、{ "title": "" } を /api/tasks に POST します:400 と上記のエラーが返ります。GET /api/tasks を送信します:タスクは引き続き3件です。{ "title": " ", "done": true } を /api/tasks/1 に PUT します:400 が返り、タスク1のタイトルはそのままです。{ "title": "Order new chairs" } を POST します:id 4 とともに201が返ります。
自分で試してみよう
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);
このレッスンには短いクイズがあります。レッスンを始めて解答し、進捗を記録しましょう。