GET: получение ресурса
POST: создание нового ресурса
PUT: обновление существующего ресурса
DELETE: удаление ресурса
Например, если мы хотим получить список всех пользователей, можем использовать HTTP-метод GET и ресурс "пользователи". Если создать нового пользователя, POST
Связь между ресурсами и действиями
Ресурсы и действия тесно связаны между собой. Каждый ресурс может иметь несколько действий, которые можно над ним выполнять. Например, "пользователи" следующие действия:
GET /users: получение списка всех пользователей
GET /users/{id}: получение информации о конкретном пользователе
POST /users: создание нового пользователя
PUT /users/{id}: обновление существующего пользователя
DELETE /users/{id}: удаление пользователя
В этой главе мы рассмотрели, как определить ресурсы и действия в REST-api. следующей рассмотрим, проектировать URL-адреса для наших ресурсов действий, использовать HTTP-методы выполнения действий над ресурсами.
3.2. Создание схемы API
В предыдущей главе мы рассмотрели основные принципы проектирования REST-api и узнали, как определить ресурсы методы, которые будут использоваться в нашем API. Теперь пришло время создать схему API, которая будет служить основой для нашего приложения.
Что такое схема API?
Схема API (Application Programming Interface) – это набор правил и соглашений, которые определяют, как клиенты могут взаимодействовать с нашим API. Она описывает структуру запросов ответов, форматы данных, методы аутентификации авторизации, а также другие важные аспекты нашего
Зачем нужна схема API?
Схема API необходима для того, чтобы обеспечить ясность и последовательность в нашем API. Она помогает разработчикам понять, как использовать наш API, какие данные они могут ожидать ответ. Кроме схема служит документацией нашего что облегчает его поддержку развитие.
Элементы схемы API
Схема API обычно включает в себя следующие элементы:
Методы: GET, POST, PUT, DELETE и другие методы, которые будут использоваться в нашем API.
Ресурсы: URI-адреса, которые будут использоваться для доступа к ресурсам нашего API.
Параметры запроса: параметры, которые будут передаваться в запросах, такие как идентификаторы, фильтры и сортировки.