falcon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Pallavi Rao (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FALCON-438) Auto generate documentation for REST API
Date Mon, 21 Sep 2015 09:45:05 GMT

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

Pallavi Rao commented on FALCON-438:
------------------------------------

+1 for that. If we can bundle the docs along with our webapp, users won't need to visit the
Falcon documentation page as it will available on the server.

> 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
>
> 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)

Mime
View raw message