For JAX-RS I prefer use MireDot as a REST API doc generator
With MireDot you do not need to use additional annotations, like @Api:
@Api(value = "/pet", description = "Operations about pets")
It will parse your JAX-RS annotation and pure javadoc:
* Operations about pets
and generate beautiful and user friendly documentation, like this:
Swagger example: http://petstore.swagger.io/
And MireDot is free for open source projects!
Think about this alternative for Swagger. I'm able to prepare Pull Request
for UPS next week.
2015-04-04 9:43 GMT+03:00 Matthias Wessendorf <matzew(a)apache.org>:
On Fri, Apr 3, 2015 at 10:27 PM, Heiko W.Rupp <hrupp(a)redhat.com> wrote:
> On 3 Apr 2015, at 18:53, Andrea Vibelli wrote:
> > we are using it in Project Newcastle with annotations on the
> > endpoints, and
> > it's really handy.
> All the JBoss ON 3.2+ and RHQ REST-docs are generated from JAX-RS +
> Swagger annotations.
> In Hawkular we are basically doing the same, but with a different
> annotation processor.
we are, atm, doing similar:
but the jaxrs doclet does not work w/ JDK8 - something has to change here
So, I am all for using Swagger annotations on the code to generate the
HTML docs :-)
> I personally think the best is really to have the annotations in the
> source and not trying
> to update a separate .yml file, as the latter usually is much easier
> aerogear-dev mailing list
aerogear-dev mailing list
Twitter: @idelpivnitskiy <https://twitter.com/idelpivnitskiy>
GitHub: @idelpivnitskiy <https://github.com/idelpivnitskiy>