-
Type:
Feature Request
-
Resolution: Fixed
-
Priority:
L3 - Default
-
Affects Version/s: None
-
Component/s: run
-
None
Component
https://github.com/camunda/camunda-bpm-platform/tree/master/distro/run
User story
I want to access an instance of Swagger UI (https://swagger.io/tools/swagger-ui/) with Camunda's OpenAPI description (https://docs.camunda.org/manual/7.13/reference/rest/openapi/) so that I can easily explore the REST API without having to switch platforms.
Background
Currently I need to download the JSON from Camunda and put it into a third-party tool. This is cumbersome.
Acceptance Criteria
- When I start Run without arguments, the Swagger UI is automatically exposed displaying the Camunda REST API endpoints (must be mentioned in update guide as well, since it changes the default behavior)
- The Swagger UI is configured by default such that it can directly make requests against Run's REST API without further user configuration
- There is a startup argument with which I can toggle Swagger UI (similar to how it works for REST API and webapps: https://docs.camunda.org/manual/7.13/user-guide/camunda-bpm-run/#disable-webapps-or-rest-api)
Implementation hints
- If achievable with moderate effort, the Swagger UI classes should not be in the classpath when Swagger UI is disabled