Menu
CoddyTech

CORS

Coddy'nin ASP.NET Core Journey'sinin REST API'leri bölümünün bir parçası. Ders 17 / 20.

https://shop.example.com adresindeki bir sayfa, API'nizi fetch ile çağırıyor ve tarayıcı yanıtı engelliyor. Sunucu CORS başlıklarıyla diğer kaynaklara izin vermediği sürece tarayıcılar, bir sayfanın yalnızca kendi kaynağından (şema, ana makine ve bağlantı noktası) gelen yanıtları okumasına izin verir. Bir PUT, PATCH, DELETE veya JSON gövdesinden önce tarayıcı, önce ön denetim olan bir OPTIONS isteği gönderir ve gerçek isteği yalnızca yanıt izin verirse gönderir.

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 ara yazılımı, ön denetim isteğini 204 ve izin verilen yöntemlerle başlıkları içeren bir yanıtla karşılar ve bu kaynak için her yanıta Access-Control-Allow-Origin ekler. Başka bir kaynak CORS başlıkları almaz, bu yüzden tarayıcısı isteği engeller. CORS'u yalnızca tarayıcılar uygular: curl ve istek çubuğu bunu dikkate almaz.

challenge icon

Görev

Orta

Başka bir sitedeki pano uygulaması, https://board.example.com, tarayıcıdan API'nizi çağırmak istiyor. Bu kaynağa ve yalnızca ona izin verin.

  1. Program.cs dosyasında, builder.Build() öncesinde, builder.Services.AddCors ile board adlı bir CORS ilkesi ekleyin. Bu ilke https://board.example.com kaynağına, GET, POST, PUT, PATCH ve DELETE yöntemlerine ve Content-Type başlığına izin verir.
  2. Pano, X-Total-Count değerinden "page 1 of 3" bilgisini gösteriyor. Sunucu daha fazlasını kullanıma açmadıkça başka bir kaynaktaki sayfa yalnızca birkaç standart yanıt başlığını okuyabilir; bu nedenle ilkeye .WithExposedHeaders("X-Total-Count") ekleyin.
  3. app.UseStatusCodePages(); sonrasında, app.UseCors("board"); ile ilkeyi etkinleştirin.

Panodan gelen bir ön kontrol isteği, şu başlıklarla 204 yanıtı verir:

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

Deneyin: Run'a basın, OPTIONS'ı ve /api/tasks/2 yolunu seçin; Origin: https://board.example.com ve Access-Control-Request-Method: DELETE başlıklarını ekleyin. Gönderin: Headers sekmesinde 204, boş bir gövde ve yukarıdaki başlıklar. Aynı Origin ile GET /api/tasks gönderin: Access-Control-Allow-Origin ve Access-Control-Expose-Headers ile birlikte 200 yanıtı alırsınız. Origin: https://evil.example.com ile yanıt CORS başlıkları içermez.

Kendin dene

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 iconKendini test et

Bu ders kısa bir quiz içerir. Soruları yanıtlamak ve ilerlemeni kaydetmek için derse başla.

REST API'leri bölümündeki tüm dersler