[GitHub] [atlas] nikhilbonte opened a new pull request #115: ATLAS-3913 Swagger documentation for APIs

[GitBox]

nikhilbonte opened a new pull request #115:
URL: https://github.com/apache/atlas/pull/115


   Currently, swagger documentation is not available with packaging.
   This change will allow atlas server deployment to host its REST API doc 
using swagger.
   
   Approach:
   
   1. Update enuntiate plugin version from 2.11.1 to 2.13.2
   2. Download latest swagger-ui from 
[v3.36.2.zip](https://github.com/swagger-api/swagger-ui/archive/v3.36.2.zip) & 
extract.
   3. Move swagger-ui-3.36.2/dist/* to build-tools/src/main/resources/ui-dist
   4. Update swagger tag in enuntiate.xml
   5. Inside build-tools/src/main/resources/ui-dist :
        * Create index.js
        * Modify SwaggerUIBundle object in ui-dist/index.html to load index.js
            > url to load swagger.json
            > Add requestInterceptor
   6. 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**
   <img width="332" alt="image" 
src="https://user-images.githubusercontent.com/44048490/99964008-a62afe80-2db8-11eb-8ecd-cea617fe7f4a.png";>
   
   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org