[
https://issues.apache.org/jira/browse/FALCON-438?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14805318#comment-14805318
]
Narayan Periwal commented on FALCON-438:
----------------------------------------
To auto-generate the documentation for the rest api's, there is an enunciate
plugin available in Maven. We can run enunciate as part of our build process
and it generates nice HTML based documentation of our web services. It uses the
javadoc of the api's for the documentation purpose.
> 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: Pracheer Agarwal
>
> 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)
