Menu
CoddyTech

CORS

Coddy ASP.NET Core 여정의 REST API 섹션에 포함된 레슨. 20개 중 17번째.

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과 요청 표시줄은 이를 무시합니다.

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를 통해 "page 1 of 3"이 표시됩니다. 서버가 추가 헤더를 노출하지 않으면 다른 출처의 페이지는 몇 가지 표준 응답 헤더만 읽을 수 있으므로, 정책에 .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의 모든 레슨