Детали проблемы
Часть раздела REST API путешествия по ASP.NET Core на Coddy. Урок 8 из 20.
Пустое тело ответа 404 заставляет клиента гадать, что пошло не так. Сведения о проблеме (RFC 9457) — это стандартная структура JSON для ошибки, отправляемой с типом содержимого application/problem+json. Ваши ответы 400 уже используют её. В API заказов три строки придают всем ошибкам одинаковую структуру:
builder.Services.AddProblemDetails();
var app = builder.Build();
app.UseExceptionHandler();
app.UseStatusCodePages();Теперь запрос GET /api/orders/7 для отсутствующего заказа возвращает 404 с таким ответом:
{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
"title": "Not Found", "status": 404,
"traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00" }AddProblemDetails регистрирует службу, которая формирует эту структуру. UseStatusCodePages добавляет тело с описанием проблемы к каждому ответу с ошибкой, у которого его нет: будь то результат Results.NotFound() или путь, для которого не найден маршрут. UseExceptionHandler преобразует необработанное исключение в ответ 500 с описанием проблемы. traceId создаётся заново для каждого запроса; он связывает ответ с журналами сервера.
Задание
ЛегкоПриведи ошибки трекера задач к единому формату, чтобы клиент одинаково обрабатывал каждый сбой.
- В
Program.csдобавьbuilder.Services.AddProblemDetails();на строке передbuilder.Build(). - Сразу после
builder.Build()добавьapp.UseExceptionHandler();, а затемapp.UseStatusCodePages();, до любых конечных точек.
Больше ничего не меняй: конечные точки по-прежнему возвращают Results.NotFound(), а промежуточное ПО заполняет тело ответа. Тогда GET /api/tasks/99 вернёт ответ 404 с типом содержимого application/problem+json и таким содержимым:
{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5", "title": "Not Found", "status": 404, "traceId": "..." }Попробуй: нажми «Запустить» и отправь GET /api/tasks/99: получишь показанный выше ответ 404. Отправь GET /api/projects по пути, для которого нет маршрута: формат будет таким же. Отправь POST-запрос с телом { "title": "" } на /api/tasks: твой ответ 400 сохранит поле errors и получит поле traceId.
Попробуйте сами
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);
В этом уроке есть небольшой тест. Начните урок, чтобы ответить на вопросы и сохранить прогресс.