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

Ajay Yadava commented on FALCON-438:
------------------------------------

[~nperiwal] Can you please add the url at which the docs will be available 
along with server to the docs as well, so that users are aware that they can 
check the current version of documentation at the specified URL? Will review 
the remaining patch today.

> Auto generate documentation for REST API
> ----------------------------------------
>
>                 Key: FALCON-438
>                 URL: https://issues.apache.org/jira/browse/FALCON-438
>             Project: Falcon
>          Issue Type: Improvement
>          Components: docs
>    Affects Versions: 0.5
>            Reporter: Venkatesh Seetharam
>            Assignee: Narayan Periwal
>         Attachments: FALCON-438-v0.patch
>
>
> http://mestachs.wordpress.com/2012/08/06/rest-api-documentation/
> https://github.com/wordnik/swagger-core/wiki/Java-JAXRS-Quickstart
> http://theon.github.io/documenting-the-json-schema-of-your-rest-apis.html
> Swagger looks pretty good.



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

Reply via email to