[aerogear-dev] [JAX-RS] generation of endpoint documentation ?

Matthias Wessendorf matzew at apache.org
Thu Aug 16 10:34:11 EDT 2012


There is something w/in JBoss JAX-RS tools (got some pointers via twitter).

E.g. this was generated out of it (mostly)

http://docs.redhat.com/docs/en-US/JBoss_Operations_Network/3.1/html/Rest_API/index.html

It basically uses this:
http://git.fedorahosted.org/cgit/rhq/rhq.git/tree/modules/helpers/rest-docs-generator

and some maven fu ... :-)

-M

On Thu, Aug 16, 2012 at 4:23 PM, Bruno Oliveira <bruno at abstractj.org> wrote:

> WADL reminds me of SOAP times :) I would rather to go with an alternative
> like this https://github.com/rails/activeresource
>
> Unfortunately I only know Javadoc and WADL. We try to find an alternative
> to generate REST endpoints documentation.
>
> Let me know what do you think and feel free to add a task for me on M6, if
> you want  :)
>
> --
> "The measure of a man is what he does with power" - Plato
> -
> @abstractj
> -
> Volenti Nihil Difficile
>
> On Wednesday, August 15, 2012 at 6:40 AM, Matthias Wessendorf wrote:
>
> Hi,
>
> looking at [1] and I am wondering if there is a tool that generated
> 'human readable' description of restful endpoints
> (e.g. out of the jaxrs @nnotations + provided javadoc).
>
> Or is the only option really Web Application Description Language
> (WADL), see [2] and [3].
>
> Thx!
> Matthias
>
> [1]
> https://github.com/aerogear/as-quickstarts/blob/master/kitchensink-html5-mobile/SERVICES.md
> [2] http://www.w3.org/Submission/wadl/
> [3] http://cxf.apache.org/docs/jaxrs-services-description.html
>
> --
> Matthias Wessendorf
>
> blog: http://matthiaswessendorf.wordpress.com/
> sessions: http://www.slideshare.net/mwessendorf
> twitter: http://twitter.com/mwessendorf
> _______________________________________________
> aerogear-dev mailing list
> aerogear-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>
>
>


-- 
Matthias Wessendorf

blog: http://matthiaswessendorf.wordpress.com/
sessions: http://www.slideshare.net/mwessendorf
twitter: http://twitter.com/mwessendorf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/aerogear-dev/attachments/20120816/c4d4ce56/attachment.html 


More information about the aerogear-dev mailing list