Знакомство с API

Общая информация

• Базовая конечная точка (endpoint): localhost:8080;
• Все конечные точки возвращают: JSON-объект или JSON-массив в зависимости от количества записей в ответе. Изменить это поведение можно добавив в запрос параметр ?data_array=true тогда ответ будет JSON-массив в независимости от количества записей;
• Конечные точки заканчивающиеся на /list всегда возвратят: JSON-массив.

HTTP коды возврата

• HTTP 4XX коды возврата применимы для некорректных запросов - проблема на стороне клиента.
• HTTP 5XX коды возврата используются для внутренних ошибок - проблема на стороне сервера. Важно НЕ рассматривать это как операцию сбоя. Статус выполнения НЕИЗВЕСТЕН и может быть успешным.

Коды ошибок

• Любая конечная точка может вернуть ошибку.

Пример ответа:

{
  "error": {
    "code": 404,
    "message": "Not Found"
  }
}

Общая информация о конечных точках

• Для GET конечных точек параметры должны быть отправлены в виде строки запроса (query string) .
• Для POST конечных точек, некоторые параметры могут быть отправлены в виде строки запроса (query string), а некоторые в виде тела запроса (request body):
• При отправке параметров в виде тела запроса допустимы следующие типы контента:
  • application/x-www-form-urlencoded для query string;
  • multipart/form-data для HTML-форм;
  • application/json для JSON.
• Параметры могут быть отправлены в любом порядке.