Menu
CoddyTech

Ресурсы и URL

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

Другие программы вызывают ваш API, поэтому его URL должны быть простыми для угадывания. Большинство веб-API следуют стилю под названием REST: каждый URL указывает на ресурс — объект, который хранит API, а HTTP-метод сообщает, что с ним нужно сделать.

GET    /api/invoices      the list of invoices
GET    /api/invoices/7    invoice 7
POST   /api/invoices      add an invoice
DELETE /api/invoices/7    remove invoice 7

В путях используются существительные, а не глаголы: если использовать /api/getInvoice?id=7, каждому клиенту придётся изучать новое слово для каждого действия. Коллекция имеет название во множественном числе, а путь к одному элементу — это путь коллекции с его id.

app.MapGet("/api/invoices/{id:int}", (int id) =>
{
    var invoice = invoices.Find(i => i.Id == id);
    return invoice is null ? Results.NotFound() : Results.Ok(invoice);
});

{id:int} — параметр маршрута с ограничением: он соответствует только целым числам, поэтому /api/invoices/abc не соответствует ни одному маршруту и возвращает 404. Если id не соответствует ни одному счёту, тоже возвращается 404 — с помощью Results.NotFound().

challenge icon

Задание

Легко

В этом разделе ты создашь API для отслеживания задач. Изначально в нём три задачи и GET /api/tasks, который возвращает их все. Задачи представлены записями TaskItem, потому что в .NET уже есть тип с именем Task. Добавь URL для одной задачи.

  1. В Program.cs, ниже GET /api/tasks, добавь сопоставление для GET /api/tasks/{id:int}.
  2. Найди задачу, у которой Id равен id, с помощью tasks.Find и верни её с помощью Results.Ok(task). На запрос GET /api/tasks/2 возвращается:
    { "id": 2, "title": "Book the meeting room", "done": true }
  3. Если задачи с таким идентификатором нет, верни Results.NotFound(): статус 404 с пустым телом ответа.

Попробуй: нажми «Запустить». В столбце отправляется запрос GET /api/tasks и отображаются три задачи. Отправь GET /api/tasks/2: ответ 200 и задача выше. Отправь GET /api/tasks/99: ответ 404. Отправь GET /api/tasks/abc: тоже ответ 404, потому что {id:int} соответствует только числам.

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

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

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

app.Run();

record TaskItem(int Id, string Title, bool Done);
quiz iconПроверьте себя

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

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