Из чего состоит структура REST-запроса

Структура REST-запроса

REST-запрос — это стандартизированный способ взаимодействия между клиентом и сервером, основанный на протоколе HTTP. Понимание его структуры крайне важно для тестирования API.

Основные компоненты REST-запроса:

1. HTTP метод (Verb) Определяет действие, которое клиент хочет выполнить:

• GET — получение данных (безопасный, идемпотентный)
• POST — создание нового ресурса
• PUT — полное обновление существующего ресурса
• PATCH — частичное обновление ресурса
• DELETE — удаление ресурса
• HEAD — как GET, но без тела ответа
• OPTIONS — получение информации о доступных методах

2. URL (Endpoint/URI) Полный путь до ресурса, включающий:

• Протокол: https://
• Домен: api.example.com
• Версия API: /v1
• Путь ресурса: /users/123
• Query параметры: ?filter=active&sort=date (для GET запросов)

3. Headers (Заголовки) Метаинформация о запросе:

• Content-Type — формат передаваемых данных (application/json)
• Authorization — учётные данные (Bearer token, API key)
• User-Agent — информация о клиенте
• Custom заголовки (X-Request-ID, X-API-Version)

4. Body (Тело запроса) Данные, передаваемые серверу:

• Используется для POST, PUT, PATCH запросов
• Обычно в формате JSON
• GET и DELETE запросы обычно не имеют тела
• Должен соответствовать Content-Type заголовку

Практический пример:

POST https://api.example.com/v1/users
Headers:
  Content-Type: application/json
  Authorization: Bearer token123
  
Body:
{
  "name": "John",
  "email": "john@example.com"
}

Важно для QA:

• Проверять корректность формирования каждого компонента
• Тестировать граничные случаи (очень длинный URL, специальные символы в body)
• Валидировать обработку ошибок при неправильной структуре
• Убедиться, что сервер корректно интерпретирует все компоненты запроса