Пример:
GET
https://meetsga.com/api/public/v1/events/{evetnId}
🔸 Метод HTTP
GET, POST, PUT, PATCH, DELETE
Не относится к URL, но связан с ним.
Подробнее тут.
🔸 Протокол
Для REST API всегда HTTP / HTTPs.
🔸 Доменное имя
Основной адрес, по которому можно обращаться к серверу с API-приложением.
🔸 Путь (Path)
Включает в себя один или несколько сегментов, разделённых слешами (/):
▫️api - указатель на каталог API сервера, может быть в доменном имени.
▫️имя API - указывает на конкретный интерфейс API, предназначенный для разных пользователей системы, либо для разных микросервисов.
▫️v1 - версия API, важна для поддержки совместимости с предыдущими версиями.
▫️Эндпонит
▫️▫️events - это ресурс, к которому осуществляется доступ. В данном случае “встреча”. Может быть в единственном числе (event).
▫️▫️{eventId} - это параметр в пути URL (path-параметр), указывающий на конкретный рецепт по его id в БД системы. Фигурные скобки {} обозначают переменную часть URL, значение которой должно быть предоставлено клиентом (например, идентификатор 232324).
▫️▫️ иерархия с вложенными сущностями / действия над объектами.
🔸 Query-параметры (Query-parameters)
Дополнительные параметры запроса после ?, необязательны.
Если их несколько, то перечисление через символ &.
Обычно используются для фильтров, сортировок и пагинации при получении списков методом GET, но могут быть и в других методах.
В примере:
GET …/events?offset=0&limit=10&date=2025-07-07&organizerId=123
👉 ?offset=0&limit=10 - запрос результатов с 0-го, ограниченный 10-ю на страницу. Это два отдельных query-параметра - элементы пагинации (постраничного получения данных).
👉 date и organizerId - фильтры по дате и id создателя встречи.
Больше примеров в картинках к посту 📄
Благодаря такой структуре разработчикам и другим пользователям API всегда понятно, каким ресурсом (сущностью) управляет REST API метод 🙌
#RestApiGA #MeetsGA