Menu
CoddyTech

CORS

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

https://shop.example.com上のページがfetchでAPIを呼び出すと、ブラウザーは応答をブロックします。ブラウザーがページからの読み取りを許可する応答は、サーバーがCORSヘッダーで他のオリジンを許可していない限り、そのページ自身のオリジン(スキーム、ホスト、ポート)からのものだけです。PUT、PATCH、DELETE、またはJSONボディを使う場合、ブラウザーはまずOPTIONSリクエスト、つまりプリフライトを送信し、その応答で許可された場合にのみ実際のリクエストを送信します。

builder.Services.AddCors(options =>
    options.AddPolicy("shop", policy => policy
        .WithOrigins("https://shop.example.com")
        .WithMethods("GET", "POST")
        .WithHeaders("Content-Type")));
var app = builder.Build();
app.UseCors("shop");

CORSミドルウェアは、プリフライトに204と許可されたメソッドおよびヘッダーを返し、そのオリジンへのすべての応答にAccess-Control-Allow-Originを追加します。別のオリジンにはCORSヘッダーが付かないため、そのブラウザーはリクエストをブロックします。CORSを適用するのはブラウザーだけです。curlとリクエストバーはCORSを無視します。

challenge icon

チャレンジ

中級

別のサイトにあるボードアプリ https://board.example.com から、ブラウザー経由であなたのAPIを呼び出したいとしています。そのオリジンだけを許可しましょう。

  1. Program.csで、builder.Build()の前に、builder.Services.AddCorsを使ってboardという名前のCORSポリシーを追加します。このポリシーでは、オリジンhttps://board.example.com、メソッドGET、POST、PUT、PATCH、DELETE、およびヘッダーContent-Typeを許可します。
  2. ボードにはX-Total-Countを使って「全3ページ中の1ページ目」と表示します。サーバーが追加のヘッダーを公開しない限り、別のオリジンからのページでは標準のレスポンスヘッダーのうち一部しか読み取れないため、ポリシーに.WithExposedHeaders("X-Total-Count")を追加します。
  3. app.UseStatusCodePages();の後に、app.UseCors("board");を使ってポリシーを有効にします。

ボードからのプリフライトリクエストには、次のヘッダーを付けて204が返されます。

Access-Control-Allow-Origin: https://board.example.com
Access-Control-Allow-Methods: GET,POST,PUT,PATCH,DELETE
Access-Control-Allow-Headers: Content-Type

試してみましょう:「実行」を押し、OPTIONSを選択して、パスに/api/tasks/2を指定し、ヘッダーOrigin: https://board.example.comとAccess-Control-Request-Method: DELETEを追加します。送信すると、204、空の本文、および上記のヘッダーが「Headers」タブに表示されます。同じOriginを付けてGET /api/tasksを送信すると、Access-Control-Allow-OriginとAccess-Control-Expose-Headersを含む200が返されます。Origin: https://evil.example.comの場合、レスポンスにCORSヘッダーはありません。

自分で試してみよう

using System.ComponentModel.DataAnnotations;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddProblemDetails();
var app = builder.Build();

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

var tasks = new List<TaskItem>
{
    new(1, "Write the project brief", false, 1),
    new(2, "Book the meeting room", true, 3),
    new(3, "Send the invoice", false),
};
var nextId = 4;

bool TitleTaken(string title, int exceptId) =>
    tasks.Any(t => t.Id != exceptId && string.Equals(t.Title, title, StringComparison.OrdinalIgnoreCase));

app.MapGet("/api/tasks", (bool? done, string? search, int? priority, string? sort, HttpResponse response, int page = 1, int pageSize = 10) =>
{
    var errors = new Dictionary<string, string[]>();
    if (sort is not null && sort != "id" && sort != "title" && sort != "priority")
        errors["sort"] = ["Sort by id, title or priority."];
    if (priority is < 1 or > 3)
        errors["priority"] = ["Priority is 1 to 3."];
    if (page < 1)
        errors["page"] = ["Page starts at 1."];
    if (pageSize < 1 || pageSize > 50)
        errors["pageSize"] = ["Page size is 1 to 50."];
    if (errors.Count > 0) return Results.ValidationProblem(errors);

    IEnumerable<TaskItem> result = tasks;
    if (done is not null) result = result.Where(t => t.Done == done);
    if (!string.IsNullOrWhiteSpace(search))
        result = result.Where(t => t.Title.Contains(search, StringComparison.OrdinalIgnoreCase));
    if (priority is not null) result = result.Where(t => t.Priority == priority);
    if (sort == "title") result = result.OrderBy(t => t.Title);
    if (sort == "priority") result = result.OrderBy(t => t.Priority);

    var matching = result.ToList();
    response.Headers["X-Total-Count"] = matching.Count.ToString();
    return Results.Ok(matching.Skip((page - 1) * pageSize).Take(pageSize));
});

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);
    if (TitleTaken(input.Title, 0))
        return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
    var task = new TaskItem(nextId++, input.Title, input.Done, input.Priority);
    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();
    if (TitleTaken(input.Title, id))
        return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
    tasks[index] = new TaskItem(id, input.Title, input.Done, input.Priority);
    return Results.Ok(tasks[index]);
});

app.MapPatch("/api/tasks/{id:int}", (int id, TaskPatch patch) =>
{
    var errors = Validation.Errors(patch);
    if (errors is not null) return Results.ValidationProblem(errors);
    var index = tasks.FindIndex(t => t.Id == id);
    if (index == -1) return Results.NotFound();
    if (patch.Title is not null && TitleTaken(patch.Title, id))
        return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
    var task = tasks[index];
    tasks[index] = task with
    {
        Title = patch.Title ?? task.Title,
        Done = patch.Done ?? task.Done,
        Priority = patch.Priority ?? task.Priority,
    };
    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.MapDelete("/api/tasks", (bool? done) =>
{
    if (done != true)
    {
        return Results.ValidationProblem(new Dictionary<string, string[]>
        {
            ["done"] = ["Add ?done=true to delete the done tasks."],
        });
    }
    tasks.RemoveAll(t => t.Done);
    return Results.NoContent();
});

app.Run();

record TaskItem(int Id, string Title, bool Done, int Priority = 2);
record TaskInput(
    [property: Required(ErrorMessage = "Title is required."), StringLength(80)] string Title,
    bool Done,
    [property: Range(1, 3)] int Priority = 2);
record TaskPatch(string? Title, bool? Done, [property: Range(1, 3)] int? Priority);
quiz icon腕試し

このレッスンには短いクイズがあります。レッスンを始めて解答し、進捗を記録しましょう。

REST APIのすべてのレッスン