<div dir="ltr">Yes, Swagger can generate doc on the fly, but Swagger use its own annotations instead of parse JAX-RS annotations and javadoc, like MireDot.<div>What about licence: Apache Tika, for example, uses pro version of MireDot</div><div><br></div><div><a href="https://github.com/apache/tika/blob/5fbc56cca94b9da0a914e82dd466abb139f9e3f4/tika-server/pom.xml#L248-L266">https://github.com/apache/tika/blob/5fbc56cca94b9da0a914e82dd466abb139f9e3f4/tika-server/pom.xml#L248-L266</a><br><div class="gmail_extra"><br><div class="gmail_quote">2015-04-07 13:48 GMT+03:00 Matthias Wessendorf <span dir="ltr">&lt;<a href="mailto:matzew@apache.org" target="_blank">matzew@apache.org</a>&gt;</span>:<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"><div dir="ltr">Swagger allows doc on the source as well, right ? Just wondering.<div><br></div><div>REgarding license, I need to double check on that before...</div></div><div><div><div class="gmail_extra"><br><div class="gmail_quote">On Tue, Apr 7, 2015 at 11:57 AM, Idel Pivnitskiy <span dir="ltr">&lt;<a href="mailto:idel.pivnitskiy@gmail.com" target="_blank">idel.pivnitskiy@gmail.com</a>&gt;</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"><div dir="ltr"><div>Matthias,<br></div><div><br></div>Sure, I will work on it.<div>But I think that it would be better if you request a license [1] on your email and forward it to me.</div><div>It won&#39;t be a problem to use a free version, but pro version has a very cool features, like:</div><div><ul><li>Display javadoc comments for the fields of json payloads and enums<br></li><li>JSON field documentation<br></li><li>Type replacement (custom serialisation, JSON types)<br></li></ul></div><div>Please, request a li</div><div><br></div><div>[1] <a href="http://miredot.com/price/" target="_blank">http://miredot.com/price/</a></div></div><div><div><div class="gmail_extra"><br><div class="gmail_quote">2015-04-07 12:44 GMT+03:00 Matthias Wessendorf <span dir="ltr">&lt;<a href="mailto:matzew@apache.org" target="_blank">matzew@apache.org</a>&gt;</span>:<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"><div dir="ltr"><span style="font-size:12.8000001907349px">Idel,</span><div><span style="font-size:12.8000001907349px"><br></span></div><div><span style="font-size:12.8000001907349px">would you mind to create a branch for us, so we can investigate the MireDot solution? also the build should be working w/ JDK8.</span><br></div><div><span style="font-size:12.8000001907349px"><br></span></div><div><span style="font-size:12.8000001907349px">ATM we use jax-doclet ([1]) which does not work w/ JDK 8 - but it does not really use any fancy annotations (e.g. see [2]) - that&#39;s why we picked it.</span></div><div><span style="font-size:12.8000001907349px"><br></span></div><div><span style="font-size:12.8000001907349px">Thanks!</span></div><div><span style="font-size:12.8000001907349px">Matthias</span></div><div><span style="font-size:12.8000001907349px"><br></span></div><div><span style="font-size:12.8000001907349px">[1] <a href="http://fromage.github.io/jax-doclets/docs/0.10.0/html/" target="_blank">http://fromage.github.io/jax-doclets/docs/0.10.0/html/</a></span></div><div><span style="font-size:12.8000001907349px">[2] <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></span></div><div class="gmail_extra"><br><div class="gmail_quote"><span>On Tue, Apr 7, 2015 at 9:54 AM, Lukáš Fryč <span dir="ltr">&lt;<a href="mailto:lukas.fryc@gmail.com" target="_blank">lukas.fryc@gmail.com</a>&gt;</span> wrote:<br></span><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"><div dir="ltr"><div>I agree with Idel that DRY approach in Miredot&#39;s case seems more appealing.<br></div><div><br></div><div>They offer basic docs generation in Free version, but also Pro version for open-source projects under conditions that Aerogear meets [1].</div><div><br></div><div>~ Lukas</div><div><br></div><div>[1] <a href="http://www.miredot.com/price/" target="_blank">http://www.miredot.com/price/</a><br><br><div class="gmail_quote">ne 5. 4. 2015 v 20:00 odesílatel Idel Pivnitskiy &lt;<a href="mailto:idel.pivnitskiy@gmail.com" target="_blank">idel.pivnitskiy@gmail.com</a>&gt; napsal:</div><div><div><div class="gmail_quote"><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"><div dir="ltr">For JAX-RS I prefer use MireDot as a REST API doc generator<div><a href="http://www.miredot.com/" target="_blank">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,&#39;Liberation Mono&#39;,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 style="color:rgb(24,54,145)"><span>&quot;</span>/pet<span>&quot;</span></span>)
@Api(value <span style="color:rgb(167,29,93)">=</span> <span style="color:rgb(24,54,145)"><span>&quot;</span>/pet<span>&quot;</span></span>, description <span style="color:rgb(167,29,93)">=</span> <span style="color:rgb(24,54,145)"><span>&quot;</span>Operations about pets<span>&quot;</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,&#39;Liberation Mono&#39;,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 style="color:rgb(24,54,145)"><span>&quot;</span>/pet<span>&quot;</span></span>)</pre></div><div>and generate beautiful and user friendly documentation, like this: <a href="http://www.miredot.com/exampledocs/" target="_blank">http://www.miredot.com/<u></u>exampledocs/</a></div><div>Swagger example: <a href="http://petstore.swagger.io/" target="_blank">http://petstore.<u></u>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&#39;m able to prepare Pull Request for UPS next week.</div><div><br></div></div><div class="gmail_extra"></div><div class="gmail_extra"><br><div class="gmail_quote">2015-04-04 9:43 GMT+03:00 Matthias Wessendorf <span dir="ltr">&lt;<a href="mailto:matzew@apache.org" target="_blank">matzew@apache.org</a>&gt;</span>:<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"><div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote"><span>On Fri, Apr 3, 2015 at 10:27 PM, Heiko W.Rupp <span dir="ltr">&lt;<a href="mailto:hrupp@redhat.com" target="_blank">hrupp@redhat.com</a>&gt;</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>
&gt; we are using it in Project Newcastle with annotations on the<br>
&gt; endpoints, and<br>
&gt; it&#39;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/<u></u>aerogear-unifiedpush-server/<u></u>blob/master/jaxrs/src/main/<u></u>java/org/jboss/aerogear/<u></u>unifiedpush/rest/sender/<u></u>PushNotificationSenderEndpoint<u></u>.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/<u></u>specs/aerogear-unifiedpush-<u></u>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><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>______________________________<u></u>_________________<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/<u></u>mailman/listinfo/aerogear-dev</a><br>
</div></div></blockquote></span></div><span><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.<u></u>wordpress.com/</a><br>sessions: <a href="http://www.slideshare.net/mwessendorf" target="_blank">http://www.slideshare.net/<u></u>mwessendorf</a><br>twitter: <a href="http://twitter.com/mwessendorf" target="_blank">http://twitter.com/mwessendorf</a></div>
</font></span></div></div>
<br>______________________________<u></u>_________________<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/<u></u>mailman/listinfo/aerogear-dev</a><br></blockquote></div><br><br clear="all"><div><br></div></div><div class="gmail_extra">-- <br><div><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>
______________________________<u></u><u></u>_________________<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/<u></u>mailma<u></u>n/listinfo/aerogear-dev</a></blockquote></div></div></div></div></div>
<br>_______________________________________________<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></blockquote></div></div></div><div><div><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>
</div></div></div></div>
<br>_______________________________________________<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></blockquote></div><br><br clear="all"><div><br></div>-- <br><div><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>
</div></div><br>_______________________________________________<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></blockquote></div><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>
</div>
</div></div><br>_______________________________________________<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></blockquote></div><br><div><div dir="ltr"><div dir="ltr"><br></div></div></div>
</div></div></div>