Uploaded image for project: 'camunda BPM'
  1. camunda BPM
  2. CAM-11497

I can use the Swagger UI in camunda-bpm-run

    XMLWordPrintable

    Details

    • Type: Feature Request
    • Status: Closed
    • Priority: L3 - Default
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 7.15.0-alpha5, 7.15.0
    • Component/s: run
    • Labels:
      None

      Description

      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

        mgm-controller-panel

        This is the controller panel for Smart Panels app

          Attachments

            Issue Links

              Activity

                People

                Assignee:
                anton.weltzien Anton von Weltzien
                Reporter:
                meyer Daniel Meyer
                Votes:
                2 Vote for this issue
                Watchers:
                5 Start watching this issue

                  Dates

                  Created:
                  Updated:
                  Resolved:

                    Salesforce