Uploaded image for project: 'Atlas'
  1. Atlas
  2. ATLAS-3913

Swagger documentation for APIs

Attach filesAttach ScreenshotVotersWatch issueWatchersCreate sub-taskLinkCloneUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

Details

    Description

      Current packaging does not package swagger ui into Atlas war.

      This change will pack swagger ui into the war file.

      Also update enunciate version from 2.11.1 to 2.13.2

      Approach:

      • Update enuntiate plugin version from 2.11.1 to 2.13.2
      • Download latest swagger-ui from https://github.com/swagger-api/swagger-ui/archive/v3.36.2.zip & extract.
      • Move swagger-ui-3.36.2/dist/<required_files> to build-tools/src/main/resources/ui-dist
      • Update swagger tag in enuntiate.xml
      • Inside build-tools/src/main/resources/ui-dist :
      • Create index.js
      • Modify SwaggerUIBundle object in ui-dist/index.html to load index.js along with following:
        1.  Modify url to load swagger.json
        2.  Add requestInterceptor
      • Updated Header.js, UrlLinks.js, Header.html to add API documentation menu.

       

      How to navigate to the documentation page?

      -> Once Atlas UI is loaded, goto Logged-in-User -> Help -> API Documentation (see attached screenshot for reference)

      Attachments

        Activity

          This comment will be Viewable by All Users Viewable by All Users
          Cancel

          People

            nbonte Nikhil P Bonte
            nbonte Nikhil P Bonte
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0h
                0h
                Logged:
                Time Spent - 0.5h
                0.5h

                Issue deployment