users@jsr311.java.net

Re: documenting rest-interfaces

From: cowwoc <cowwoc_at_bbs.darktech.org>
Date: Mon, 28 Sep 2009 22:21:20 -0400

        Too many steps. Is there a tool that will generate RESTful
documentation in a single step? Javadoc is a perfect example of what we
mean.

Gili

Marc Hadley wrote:
> On Sep 28, 2009, at 11:03 AM, Reto Bachmann-Gmür wrote:
>>
>> I was wondering if somebody already wrote a tool to generate
>> documentation of the rest-api from root-resource classes. The minimum
>> would be to extends the javadoc to inlude the values of the relevant
>> annotations.
>>
> Jersey generates a basic WADL description at runtime. It also has a
> compile-time extension that extracts Javadoc and puts that into the
> generated WADL too. An XSLT stylesheet is available to turn WADL into
> HTML for browser consumption.
>
> http://wikis.sun.com/display/Jersey/WADL
>
> Marc.
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe_at_jsr311.dev.java.net
> For additional commands, e-mail: users-help_at_jsr311.dev.java.net