falcon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Narayan Periwal (JIRA)" <j...@apache.org>
Subject [jira] [Comment Edited] (FALCON-438) Auto generate documentation for REST API
Date Tue, 22 Sep 2015 07:05:04 GMT

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

Narayan Periwal edited comment on FALCON-438 at 9/22/15 7:04 AM:
-----------------------------------------------------------------

[~ajayyadava], I will add the url at which the docs will be available.
Just to mention here, The current version of the rest api's documentation will be available
in the falcon server at the url http://<HOST>:<PORT>/docs


was (Author: nperiwal):
[~ajayyadava], I will add the url at which the docs will be available.
Just to mention here, The current version of the rest api's documentation is also available
in the falcon server at the url http://<HOST>:<PORT>/docs

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

Mime
View raw message