[jira] [Commented] (ATLAS-328) UI: Swagger API Documentation support

["venkata madugundu (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/ATLAS-328?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15158720#comment-15158720 ] 

venkata madugundu commented on ATLAS-328:
-----------------------------------------

The Atlas REST API documentation is outdated and does not reflect the current state of Atlas REST interface. It is quite misleading to adopters of Atlas, as they would need to dig into the Atlas source code to figure out the correct REST interface.

Swagger can generate the Atlas REST API documentation as they are compliant with JAX-RS specification. As a side effect, Swagger can also generate client code for the REST API in multiple languages, which is useful for error free invocation of Atlas REST API (but that is a different topic).

Sample Swagger doc for a PetStore REST service is here - http://petstore.swagger.io/

> UI: Swagger API Documentation support
> -------------------------------------
>
>                 Key: ATLAS-328
>                 URL: https://issues.apache.org/jira/browse/ATLAS-328
>             Project: Atlas
>          Issue Type: Task
>            Reporter: roshni gadiyar
>            Priority: Minor
>              Labels: Atlas-UI
>
> Swagger API Documentation support.
> https://github.com/swagger-api/swagger-samples/tree/master/java/java-jersey2-guice



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)