Как будешь описывать API-запрос в формате REST

REST API описывается с использованием стандартных HTTP-методов (GET, POST, PUT, DELETE) и ресурс-ориентированных URL. Формат включает:

• Endpoint: URL ресурса (например, /api/users)
• Метод: HTTP-действие (GET для чтения, POST для создания)
• Параметры: Query-параметры (?id=123) или path-параметры (/users/{id})
• Тело запроса: JSON/XML для POST/PUT (если нужно передать данные)
• Заголовки: Content-Type, Authorization и др.

Пример GET-запроса для получения пользователя:

GET /api/users/123 HTTP/1.1
Host: example.com
Authorization: Bearer token123

Пример POST-запроса для создания:

POST /api/users HTTP/1.1
Host: example.com
Content-Type: application/json

{
  "name": "John",
  "email": "john@example.com"
}

Для документации часто используют Swagger/OpenAPI.