Menu
CoddyTech

Szczegóły problemu

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

Puste ciało odpowiedzi 404 pozostawia klienta z domysłami, co poszło nie tak. Szczegóły problemu (RFC 9457) to standardowy format JSON dla błędu, wysyłany z typem zawartości application/problem+json. Twoje odpowiedzi 400 już z niego korzystają. W API zamówień trzy wiersze nadają każdemu błędowi ten sam format:

builder.Services.AddProblemDetails();
var app = builder.Build();

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

Teraz żądanie GET /api/orders/7 dotyczące nieistniejącego zamówienia zwraca odpowiedź 404 z treścią:

{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
  "title": "Not Found", "status": 404,
  "traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00" }

AddProblemDetails rejestruje usługę, która zapisuje ten format. UseStatusCodePages dodaje treść opisującą problem do każdej odpowiedzi błędu, która jej nie ma — zarówno z Results.NotFound(), jak i ze ścieżki bez przypisanej trasy. UseExceptionHandler zamienia nieobsłużony wyjątek w problem 500. traceId jest nowy dla każdego żądania; łączy odpowiedź z logami serwera.

challenge icon

Wyzwanie

Łatwy

Nadaj błędom w menedżerze zadań jednolity format, aby klient odczytywał każdą awarię w ten sam sposób.

  1. W pliku Program.cs, w wierszu przed builder.Build(), dodaj builder.Services.AddProblemDetails();
  2. Bezpośrednio po builder.Build() dodaj app.UseExceptionHandler();, a następnie app.UseStatusCodePages();, przed każdym punktem końcowym.

Nie zmieniaj niczego więcej: punkty końcowe nadal będą zwracać Results.NotFound(), a oprogramowanie pośredniczące uzupełni treść odpowiedzi. Żądanie GET /api/tasks/99 zwróci wtedy odpowiedź 404 z typem zawartości application/problem+json i:

{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5", "title": "Not Found", "status": 404, "traceId": "..." }

Wypróbuj: naciśnij „Uruchom” i wyślij GET /api/tasks/99: otrzymasz powyższą odpowiedź 404. Wyślij GET /api/projects, czyli żądanie do ścieżki bez przypisanej trasy: otrzymasz odpowiedź w tym samym formacie. Wyślij żądanie POST z treścią { "title": "" } do /api/tasks: odpowiedź 400 zachowa pole errors i zyska pole traceId.

Spróbuj swoich sił

using System.ComponentModel.DataAnnotations;

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

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

app.MapGet("/api/tasks", () => tasks);

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);
    var task = new TaskItem(nextId++, input.Title, input.Done);
    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();
    tasks[index] = new TaskItem(id, input.Title, input.Done);
    return Results.Ok(tasks[index]);
});

app.MapPatch("/api/tasks/{id:int}", (int id, TaskPatch patch) =>
{
    var index = tasks.FindIndex(t => t.Id == id);
    if (index == -1) return Results.NotFound();
    var task = tasks[index];
    tasks[index] = task with
    {
        Title = patch.Title ?? task.Title,
        Done = patch.Done ?? task.Done,
    };
    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.Run();

record TaskItem(int Id, string Title, bool Done);
record TaskInput(
    [property: Required(ErrorMessage = "Title is required."), StringLength(80)] string Title,
    bool Done);
record TaskPatch(string? Title, bool? Done);
quiz iconSprawdź się

Ta lekcja zawiera krótki quiz. Zacznij lekcję, żeby na niego odpowiedzieć i śledzić swoje postępy.

Wszystkie lekcje w sekcji API REST