[ATLAS-3913] Swagger documentation for APIs

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.1.0
• Fix Version/s: 3.0.0, 2.2.0
• Component/s: atlas-core, atlas-webui
• Labels: REST_API swagger
• Assignee: Nikhil P Bonte
• Reporter: Nikhil P Bonte
• Created: 07/Aug/20 08:21
• Updated: 09/Dec/20 12:01
• Resolved: 09/Dec/20 11:52

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)

Issue Links

• links to: Code review