<div dir="ltr">For JAX-RS I prefer use MireDot as a REST API doc generator<div><a href="http://www.miredot.com/">http://www.miredot.com/</a><br></div><div><br></div><div>With MireDot you do not need to use additional annotations, like @Api:</div><div><pre style="overflow:auto;font-family:Consolas,'Liberation Mono',Menlo,Courier,monospace;font-size:13.6000003814697px;margin-top:0px;margin-bottom:0px;font-stretch:normal;line-height:1.45;padding:16px;border-radius:3px;word-wrap:normal;word-break:normal;color:rgb(51,51,51);background-color:rgb(247,247,247)">@Path(<span class="" style="color:rgb(24,54,145)"><span class="">"</span>/pet<span class="">"</span></span>)
@Api(value <span class="" style="color:rgb(167,29,93)">=</span> <span class="" style="color:rgb(24,54,145)"><span class="">"</span>/pet<span class="">"</span></span>, description <span class="" style="color:rgb(167,29,93)">=</span> <span class="" style="color:rgb(24,54,145)"><span class="">"</span>Operations about pets<span class="">"</span></span>)</pre></div><div><br></div><div>It will parse your JAX-RS annotation and pure javadoc:</div><div><pre style="overflow:auto;font-family:Consolas,'Liberation Mono',Menlo,Courier,monospace;font-size:13.6000003814697px;margin-top:0px;margin-bottom:0px;font-stretch:normal;line-height:1.45;padding:16px;border-radius:3px;word-wrap:normal;word-break:normal;color:rgb(51,51,51);background-color:rgb(247,247,247)">/**
* Operations about pets
*/
@Path(<span class="" style="color:rgb(24,54,145)"><span class="">"</span>/pet<span class="">"</span></span>)</pre></div><div>and generate beautiful and user friendly documentation, like this: <a href="http://www.miredot.com/exampledocs/">http://www.miredot.com/exampledocs/</a></div><div>Swagger example: <a href="http://petstore.swagger.io/">http://petstore.swagger.io/</a></div><div><br></div><div>And MireDot is free for open source projects!</div><div><br></div><div>Think about this alternative for Swagger. I'm able to prepare Pull Request for UPS next week.</div><div><br></div></div><div class="gmail_extra"><br><div class="gmail_quote">2015-04-04 9:43 GMT+03:00 Matthias Wessendorf <span dir="ltr"><<a href="mailto:matzew@apache.org" target="_blank">matzew@apache.org</a>></span>:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote"><span class="">On Fri, Apr 3, 2015 at 10:27 PM, Heiko W.Rupp <span dir="ltr"><<a href="mailto:hrupp@redhat.com" target="_blank">hrupp@redhat.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><span>On 3 Apr 2015, at 18:53, Andrea Vibelli wrote:<br>
<br>
> we are using it in Project Newcastle with annotations on the<br>
> endpoints, and<br>
> it's really handy.<br>
<br>
</span>All the JBoss ON 3.2+ and RHQ REST-docs are generated from JAX-RS +<br>
Swagger annotations.<br>
In Hawkular we are basically doing the same, but with a different<br>
annotation processor.<br></blockquote><div><br></div></span><div>+1000</div><div><br></div><div>we are, atm, doing similar:</div><div>source</div><div><a href="https://github.com/aerogear/aerogear-unifiedpush-server/blob/master/jaxrs/src/main/java/org/jboss/aerogear/unifiedpush/rest/sender/PushNotificationSenderEndpoint.java#L99-L102" target="_blank">https://github.com/aerogear/aerogear-unifiedpush-server/blob/master/jaxrs/src/main/java/org/jboss/aerogear/unifiedpush/rest/sender/PushNotificationSenderEndpoint.java#L99-L102</a><br></div><div>result:</div><div><a href="https://aerogear.org/docs/specs/aerogear-unifiedpush-rest/sender/index.html#POST" target="_blank">https://aerogear.org/docs/specs/aerogear-unifiedpush-rest/sender/index.html#POST</a><br></div><div><br></div><div>but the jaxrs doclet does not work w/ JDK8 - something has to change here ;-)<br></div><div>So, I am all for using Swagger annotations on the code to generate the HTML docs :-)<br></div><div><br></div><div>Greetings,</div><div>Matthias</div><span class=""><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<br>
I personally think the best is really to have the annotations in the<br>
source and not trying<br>
to update a separate .yml file, as the latter usually is much easier<br>
forgotten.<br>
<div><div>_______________________________________________<br>
aerogear-dev mailing list<br>
<a href="mailto:aerogear-dev@lists.jboss.org" target="_blank">aerogear-dev@lists.jboss.org</a><br>
<a href="https://lists.jboss.org/mailman/listinfo/aerogear-dev" target="_blank">https://lists.jboss.org/mailman/listinfo/aerogear-dev</a><br>
</div></div></blockquote></span></div><span class="HOEnZb"><font color="#888888"><br><br clear="all"><div><br></div>-- <br><div>Matthias Wessendorf <br><br>blog: <a href="http://matthiaswessendorf.wordpress.com/" target="_blank">http://matthiaswessendorf.wordpress.com/</a><br>sessions: <a href="http://www.slideshare.net/mwessendorf" target="_blank">http://www.slideshare.net/mwessendorf</a><br>twitter: <a href="http://twitter.com/mwessendorf" target="_blank">http://twitter.com/mwessendorf</a></div>
</font></span></div></div>
<br>_______________________________________________<br>
aerogear-dev mailing list<br>
<a href="mailto:aerogear-dev@lists.jboss.org">aerogear-dev@lists.jboss.org</a><br>
<a href="https://lists.jboss.org/mailman/listinfo/aerogear-dev" target="_blank">https://lists.jboss.org/mailman/listinfo/aerogear-dev</a><br></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature"><div dir="ltr"><div><div dir="ltr">Best regards,<div>Idel Pivnitskiy<br><div>E-mail: <a href="mailto:Idel.Pivnitskiy@gmail.com" target="_blank">Idel.Pivnitskiy@gmail.com</a></div></div><div>Twitter: <a href="https://twitter.com/idelpivnitskiy" target="_blank">@idelpivnitskiy</a></div><div>GitHub: <a href="https://github.com/idelpivnitskiy" target="_blank">@idelpivnitskiy</a></div></div></div></div></div>
</div>