REST API

Розглянути підхід з використанням OpenAPI специфікації у якості опису API для "transition"-дизайну.

<Сервіс / Сценарій>

<Короткий опис>

Авторизація

Публічний / потребує окремий Kong-роут / потребує авторизації / для яких ролей, тощо.

Специфікація REST-методу

<HTTP_METHOD> /<relative-uri-with-path-variables>

Table 1. Заголовки запиту
Заголовок Тип Опис

<Назва параметру>

<Тип даних>

<Опис>
Table 2. Параметри запиту
Параметр Тип Частина запиту Опис

<Назва параметру>

<Тип даних>

Параметр запиту

<Опис>
Table 3. Структура тіла запиту
Json Path Тип Опис

$.<JsonPath>

<Тип даних>

<Опис>
Приклад тіла запиту
{
}
Table 4. Структура тіла відповіді
Json Path Тип Опис

$.<JsonPath>

<Тип даних>

<Опис>
Приклад відповіді
{
}
Table 5. Коди відповіді
Код Опис

200

OK з поверненням результату…​

201

Created з поверненням результату…​

400

Некоректно сформований запит

401

Помилка автентифікації (відсутній токен доступу)

500

Серверна помилка обробки запиту

…​

Серверна помилка обробки запиту