5.8.10. Swagger документация по проекту

Документация по обобщенному REST API доступна по адресу http://files.cuba-platform.com/swagger/6.10.

Любое запущенное приложение на CUBA также экспортирует документацию конкретно для данного проекта, сгенерированную в соответствии со спецификацией Swagger версии 2.0.

Генерируемая документация доступна по следующим адресам:

  • /rest/v2/docs/swagger.yaml - YAML-версия общей документации.

  • /rest/v2/docs/swagger.json - JSON-версия общей документации.

  • /rest/v2/docs/swaggerDetailed.yaml - YAML-версия проектной документации.

  • /rest/v2/docs/swaggerDetailed.json - JSON-версия проектной документации.

Пример:

http://localhost:8080/app/rest/v2/docs/swagger.yaml
http://localhost:8080/app/rest/v2/docs/swaggerDetailed.yaml

Проектная документация может использоваться для визуализации, тестирования, или генерации клиентского кода для REST API. См. следующие инструменты: Swagger UI, Swagger Inspector, Postman, Swagger Codegen.

Документация включает в себя:

  1. CRUD-операции, такие как:

    Также для всех параметров и ответов CRUD доступна подробная модель, к примеру:

    swagger crud model

  2. Предопределённые запросы JPQL:

    swagger query

  3. Сервисы, доступные через REST:

    swagger service