Menu
CoddyTech

Strona wywołująca API

Część sekcji API REST ścieżki ASP.NET Core w Coddy. Lekcja 18 z 20.

Strona obsługiwana przez samo API ma to samo źródło, więc jej wywołania fetch nie wymagają CORS. Za obsługę plików w folderze wwwroot projektu odpowiadają dwa komponenty middleware: app.UseDefaultFiles() zamienia żądanie dotyczące / na /index.html, a app.UseStaticFiles() wysyła plik. Przepisanie musi nastąpić jako pierwsze.

const response = await fetch('/api/products');
const products = await response.json();
for (const product of products) {
    const item = document.createElement('li');
    item.textContent = product.name;
    list.append(item);
}

fetch wysyła żądanie i zwraca obietnicę zawierającą odpowiedź, a response.json() odczytuje jej treść jako JSON. Ścieżka zaczynająca się od / prowadzi do źródła samej strony. textContent wyświetla nazwę jako zwykły tekst, więc produkt o nazwie <script> nie może zostać uruchomiony jako kod.

challenge icon

Wyzwanie

Średni

Dodaj do menedżera zadań stronę wyświetlającą listę zadań. Masz nowy plik wwwroot/index.html z nagłówkiem i pustym elementem <ul id="tasks">.

  1. W Program.cs, po app.UseCors("board");, dodaj app.UseDefaultFiles();, a następnie app.UseStaticFiles();
  2. W wwwroot/index.html, w miejscu wskazanym komentarzem, napisz funkcję async function loadTasks(), która pobiera dane z /api/tasks, odczytuje JSON i dodaje do listy jeden element <li> dla każdego zadania, ustawiając tytuł jako jego textContent. Element zadania oznaczonego jako wykonane oznacz klasą done, która przekreśla tekst zgodnie ze stylami strony. Następnie wywołaj loadTasks().

Testy uruchamiają .NET, a nie przeglądarkę: sprawdzają, czy GET / zwraca stronę i czy odczytywane przez nią API nadal działa. Samą listę sprawdzisz w kolumnie.

Wypróbuj: naciśnij Run. Kolumna wysyła GET / i wyświetla stronę, na której widnieją trzy zadania, a "Book the meeting room" jest przekreślone. Wyślij GET /index.html: pojawi się ta sama strona. Wyślij żądanie POST z treścią { "title": "Order new chairs" } do /api/tasks, a następnie ponownie wyślij GET /: pojawią się cztery zadania.

Spróbuj swoich sił

using System.ComponentModel.DataAnnotations;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddProblemDetails();
builder.Services.AddCors(options =>
{
    options.AddPolicy("board", policy => policy
        .WithOrigins("https://board.example.com")
        .WithMethods("GET", "POST", "PUT", "PATCH", "DELETE")
        .WithHeaders("Content-Type")
        .WithExposedHeaders("X-Total-Count"));
});
var app = builder.Build();

app.UseExceptionHandler();
app.UseStatusCodePages();
app.UseCors("board");

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

Wszystkie lekcje w sekcji API REST