[aerogear-dev] do we want swagger for REST endpoint documentation?

Stefan Miklosovic smikloso at redhat.com
Fri Apr 3 10:07:45 EDT 2015


Do we need just that yaml or we want to integrate it directly into the
source code with this? (1)  By doing this you can just point your
browser to some url and it is generated dynamically.

Or I just write that yaml, the disadvantage is that you have to update
it every time some REST API changes to reflect it however I hesitate
to touch sources, they should not know about this.

(1) https://github.com/swagger-api/swagger-core/wiki/Java-JAXRS-Quickstart

On Fri, Apr 3, 2015 at 2:18 PM, Daniel Passos <dpassos at redhat.com> wrote:
> +9001
>
> On Fri, Apr 3, 2015 at 8:12 AM, Sebastien Blanc <scm.blanc at gmail.com> wrote:
>>
>> +1
>> feels free to PR this
>>
>> On Fri, Apr 3, 2015 at 1:10 PM, Matthias Wessendorf <matzew at apache.org>
>> wrote:
>>>
>>> that is very cool!
>>>
>>> Also this helps to retire the jaxrs doclet, that is not working w/ jdk8
>>>
>>>
>>> On Friday, April 3, 2015, Karel Piwko <kpiwko at redhat.com> wrote:
>>>>
>>>> I really like the idea!
>>>>
>>>> On Fri, Apr 3, 2015 at 11:06 AM, Stefan Miklosovic <smikloso at redhat.com>
>>>> wrote:
>>>>>
>>>>> Hello,
>>>>>
>>>>> Is there any interest to describe REST API for UPS in a Swagger?
>>>>> (1),(2)
>>>>>
>>>>> I can imagine it would be pretty handy for folks, it is just one yaml
>>>>> file to write really.
>>>>>
>>>>> It could be somehow linked in UPS web page, swagger is just pure html
>>>>> + js without any dependencies at all.
>>>>>
>>>>> (1) http://swagger.io/
>>>>> (2) http://petstore.swagger.io/#!/pet/deletePet
>>>>>
>>>>> --
>>>>> Stefan Miklosovic
>>>>> Red Hat Brno - JBoss Mobile Platform
>>>>>
>>>>> e-mail: smikloso at redhat.com
>>>>> irc: smikloso
>>>>> _______________________________________________
>>>>> aerogear-dev mailing list
>>>>> aerogear-dev at lists.jboss.org
>>>>> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>>>>
>>>>
>>>
>>>
>>> --
>>> Sent from Gmail Mobile
>>>
>>> _______________________________________________
>>> aerogear-dev mailing list
>>> aerogear-dev at lists.jboss.org
>>> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>>
>>
>>
>> _______________________________________________
>> aerogear-dev mailing list
>> aerogear-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>
>
>
>
> --
> -- Passos
>
> _______________________________________________
> aerogear-dev mailing list
> aerogear-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/aerogear-dev



-- 
Stefan Miklosovic
Red Hat Brno - JBoss Mobile Platform

e-mail: smikloso at redhat.com
irc: smikloso


More information about the aerogear-dev mailing list