Menu
CoddyTech

Отклонение некорректных данных

Часть раздела REST API путешествия по ASP.NET Core на Coddy. Урок 6 из 20.

Тело запроса может успешно привязаться, но всё равно быть бессмысленным: пустой адрес электронной почты, отрицательная цена. Верни 400 Некорректный запрос и сообщи, что не так, в формате, понятном клиентам. Results.ValidationProblem принимает словарь, связывающий имя поля с сообщениями:

if (string.IsNullOrWhiteSpace(input.Email))
{
    return Results.ValidationProblem(new Dictionary<string, string[]>
    {
        ["email"] = ["Email is required."],
    });
}

Он возвращает ответ 400 с типом содержимого application/problem+json и таким телом:

{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": { "email": ["Email is required."] } }

Проверяй запрос до внесения изменений, чтобы при отказе данные оставались такими же, как прежде. Тело, которое не является допустимым JSON, не попадёт в лямбда-функцию: ASP.NET Core вернёт для него ответ 400.

challenge icon

Задание

Легко

Сейчас POST /api/tasks с { "title": "" } добавляет задачу без названия. Запрети это.

  1. В начале лямбда-выражения POST /api/tasks, до nextId++, проверь название с помощью string.IsNullOrWhiteSpace(input.Title). Это позволяет обнаружить отсутствующее название (null), пустое название и название, состоящее из пробелов.
  2. Если проверка не пройдена, верни Results.ValidationProblem с полем title и сообщением Title is required., чтобы тело ответа содержало:
    "errors": { "title": ["Title is required."] }
  3. Добавь такую же проверку в начале лямбда-выражения PUT /api/tasks/{id:int}.

Попробуй: нажми «Запустить» и отправь POST-запрос с { "title": "" } на /api/tasks: получишь 400 и ошибки выше. Отправь GET /api/tasks: задач по-прежнему три. Отправь PUT-запрос с { "title": " ", "done": true } на /api/tasks/1: получишь 400, и название задачи 1 останется прежним. Отправь POST-запрос с { "title": "Order new chairs" }: получишь 201 с id 4.

Попробуйте сами

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 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 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(string Title, bool Done);
record TaskPatch(string? Title, bool? Done);
quiz iconПроверьте себя

В этом уроке есть небольшой тест. Начните урок, чтобы ответить на вопросы и сохранить прогресс.

Все уроки раздела REST API