Uploaded image for project: 'Thorntail'
  1. Thorntail
  2. THORN-1909

Swagger: Default the context root to JAX-RS context root

    Details

    • Type: Enhancement
    • Status: Closed (View Workflow)
    • Priority: Minor
    • Resolution: Done
    • Affects Version/s: 2018.3.3
    • Fix Version/s: 2018.4.1
    • Component/s: core
    • Labels:
      None

      Description

      Scenario:

      • Developer packages a JAX-RS Application class and sets the ApplicationPath to some value (e.g., /api )
      • Developer includes the Swagger fraction so that others can use the swagger.json to test / build their APIs.
      • Swagger fraction needs the developer to explicitly set the "swarm.deployment.*.swagger.root" value so that the baseUrl of the swagger.json file is set properly.

      It would be nice if the Swagger fraction would make its resources available by default under the JAX-RS context path.

      E.g.,

      swarm.context.path = /myapp
      swarm.deployment.*.jaxrs.application-path = /api

      Then, the expectation should be that the swagger.json file has the basePath set to "/myapp/api"

      Developers can choose to change this value by providing it declaratively via the YML configuration file.

        Gliffy Diagrams

          Attachments

            Activity

              People

              • Assignee:
                harsha.ramesh Harsha Ramesh
                Reporter:
                harsha.ramesh Harsha Ramesh
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: