Endpoints

Ниже приведён пример оформления документации по endpoint’ам.

GET /api/status

• Описание: проверка статуса сервиса.
• Ответ 200:

{
  "status": "ok"
}

Рекомендации по оформлению

• используйте заголовки уровней ## и ### для иерархии;
• выделяйте важные части полужирным;
• используйте блоки кода для примеров.