Интерактивный Swagger UI и спецификация OpenAPI

RUSEON Core автоматически генерирует и отдаёт интерактивную документацию по спецификации OpenAPI 3.0 напрямую со своего встроенного веб-сервера.

---

1. Доступ к интерфейсу Swagger UI

Откройте адрес Swagger UI в браузере:

http://localhost:8080/swagger/index.html

Прямые ссылки на файлы спецификации:

• Формат JSON: http://localhost:8080/swagger/doc.json
• Формат YAML: http://localhost:8080/swagger/doc.yaml

---

2. Авторизация запросов в Swagger UI

1. Нажмите зелёную кнопку Authorize в правом верхнем углу интерфейса.
2. Вставьте ваш JWT-токен с префиксом Bearer :

   Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

3. Нажмите Authorize $\to$ Close.
4. Теперь все тестовые запросы по кнопке Try it out будут автоматически отправлять заголовок Authorization.

---

3. Автогенерация клиентских SDK

Генерация готовых библиотек клиента на любом языке программирования с помощью утилиты OpenAPI Generator:

# Генерация клиента на TypeScript (Axios)
npx @openapitools/openapi-generator-cli generate \
  -i http://localhost:8080/swagger/doc.json \
  -g typescript-axios \
  -o ./src/api/ruseon-client

# Генерация клиента на Python
openapi-generator-cli generate \
  -i http://localhost:8080/swagger/doc.json \
  -g python \
  -o ./ruseon_python_sdk

Связанная документация

• Обзор архитектуры API
• Справочник REST API
• Аутентификация в API
• Веб-интерфейс