Menu
CoddyTech

CORS

Termasuk bagian REST API dalam perjalanan ASP.NET Core di Coddy. Pelajaran 17 dari 20.

Sebuah halaman di https://shop.example.com memanggil API-mu dengan fetch, lalu browser memblokir jawabannya. Browser mengizinkan halaman membaca jawaban hanya dari origin-nya sendiri (skema, host, dan port), kecuali server mengizinkan origin lain dengan header CORS. Sebelum permintaan PUT, PATCH, DELETE, atau permintaan dengan body JSON, browser terlebih dahulu mengirim permintaan OPTIONS, yaitu preflight, dan baru mengirim permintaan sebenarnya jika jawabannya mengizinkan.

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");

Middleware CORS menjawab preflight dengan status 204 serta metode dan header yang diizinkan, lalu menambahkan Access-Control-Allow-Origin ke setiap jawaban untuk origin tersebut. Origin lain tidak mendapatkan header CORS, sehingga browsernya memblokir permintaan itu. Hanya browser yang menerapkan CORS: curl dan bilah permintaan mengabaikannya.

challenge icon

Tantangan

Sedang

Aplikasi papan di situs lain, https://board.example.com, ingin memanggil API-mu dari browser. Izinkan origin tersebut, dan hanya origin itu.

  1. Di Program.cs, sebelum builder.Build(), tambahkan kebijakan CORS bernama board dengan builder.Services.AddCors. Kebijakan ini mengizinkan origin https://board.example.com, method GET, POST, PUT, PATCH, dan DELETE, serta header Content-Type.
  2. Papan menampilkan "page 1 of 3" dari X-Total-Count. Halaman dari origin lain hanya dapat membaca beberapa header respons standar, kecuali server mengekspos header lainnya. Jadi, tambahkan .WithExposedHeaders("X-Total-Count") ke kebijakan tersebut.
  3. Setelah app.UseStatusCodePages();, aktifkan kebijakan itu dengan app.UseCors("board");

Preflight dari papan membalas dengan 204 dan header berikut:

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

Coba: tekan Jalankan, pilih OPTIONS, path /api/tasks/2, lalu tambahkan header Origin: https://board.example.com dan Access-Control-Request-Method: DELETE. Tekan Kirim: responsnya 204, dengan body kosong dan header di atas pada tab Headers. Kirim GET /api/tasks dengan Origin yang sama: responsnya 200 dengan Access-Control-Allow-Origin dan Access-Control-Expose-Headers. Dengan Origin: https://evil.example.com, responsnya tidak memiliki header CORS.

Coba sendiri

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 iconUji dirimu

Pelajaran ini berisi kuis singkat. Mulai pelajarannya untuk menjawab kuis dan melacak progresmu.

Semua pelajaran di REST API