You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@isis.apache.org by QUALITEC - Óscar Bou <ob...@qualitec.es> on 2014/09/12 08:11:03 UTC
Swagger - API description standard. Relevant for Restful Objects?
Hi to all,
I've just recently discovered the Swagger specification.
There's an intro here [1], the full specification implementation can be found on [2] and a good example at [3].
It seems a commonly accepted way to describe REST-based APIs.
So perhaps it could be a great complement to current RestfulObjects specification.
Regards,
Oscar
[1] http://www.infoworld.com/t/web-services/swagger-aims-become-the-de-facto-standard-apis-250196?source=IFWNLE_nlt_stradev_2014-09-11
[2] https://github.com/wordnik/swagger-spec
[3] http://petstore.swagger.wordnik.com
Re: Swagger - API description standard. Relevant for Restful Objects?
Posted by Dan Haywood <da...@haywood-associates.co.uk>.
I did a bit of work this morning on our long mothballed isis-maven-plugin,
and got it working.
So it's now possible to spin up the Isis metamodel within mvn.
My original use case was to perform metamodel validation, eg detecting
misspelt supporting methods, this is what I got going.
But now we have a metamodel, it should be relatively straightforward to
define additional goals, such as "swagger" (and "raml" is another) to
generate their corresponding config files.
And I am sure many other ideas will occur to us.
Anyway, will tidy up what's there in the isis-maven-plugin, then do a bit
of playing around with swagger.
Cheers
Dan
2014-12-15 15:07 GMT+00:00 Martin Grigorov <mg...@apache.org>:
>
> Here is a short discussion at Maven users@ about Swagger and similar
> solutions: http://markmail.org/message/qpmeley7x73vba5s
>
> Martin Grigorov
> Wicket Training and Consulting
> https://twitter.com/mtgrigorov
>
> 2014-12-15 16:44 GMT+02:00 GESCONSULTOR - Óscar Bou <
> o.bou@gesconsultor.com>:
>>
>> Simply to comment.
>>
>> On [1] seems that Apache Camel latest release also documents its API
>> using Swagger.
>>
>> Regards,
>>
>> Oscar
>>
>> [1] http://www.infoq.com/news/2014/10/apache-camel-2.14
>>
>>
>> El 25/9/2014, a las 15:26, Dan Haywood <da...@haywood-associates.co.uk>
>> escribió:
>>
>> yeah, looks really nice, Swagger. Have made a note.
>>
>> On 12 September 2014 07:11, QUALITEC - Óscar Bou <ob...@qualitec.es>
>> wrote:
>>
>>
>> Hi to all,
>>
>> I've just recently discovered the Swagger specification.
>>
>> There's an intro here [1], the full specification implementation can be
>> found on [2] and a good example at [3].
>>
>> It seems a commonly accepted way to describe REST-based APIs.
>>
>> So perhaps it could be a great complement to current RestfulObjects
>> specification.
>>
>> Regards,
>>
>> Oscar
>>
>>
>>
>>
>> [1]
>>
>> http://www.infoworld.com/t/web-services/swagger-aims-become-the-de-facto-standard-apis-250196?source=IFWNLE_nlt_stradev_2014-09-11
>>
>> [2] https://github.com/wordnik/swagger-spec
>>
>> [3] http://petstore.swagger.wordnik.com
>>
>>
>>
>> Óscar Bou Bou
>> Responsable de Producto
>> Auditor Jefe de Certificación ISO 27001 en BSI
>> CISA, CRISC, APMG ISO 20000, ITIL-F
>>
>> 902 900 231 / 620 267 520
>> http://www.twitter.com/oscarbou
>>
>> http://es.linkedin.com/in/oscarbou
>>
>> http://www.GesConsultor.com <http://www.gesconsultor.com/>
>>
>>
>>
>> Este mensaje y los ficheros anexos son confidenciales. Los mismos
>> contienen información reservada que no puede ser difundida. Si usted ha
>> recibido este correo por error, tenga la amabilidad de eliminarlo de su
>> sistema y avisar al remitente mediante reenvío a su dirección electrónica;
>> no deberá copiar el mensaje ni divulgar su contenido a ninguna persona.
>> Su dirección de correo electrónico junto a sus datos personales constan
>> en un fichero titularidad de Gesdatos Software, S.L. cuya finalidad es la
>> de mantener el contacto con Ud. Si quiere saber de qué información
>> disponemos de Ud., modificarla, y en su caso, cancelarla, puede hacerlo
>> enviando un escrito al efecto, acompañado de una fotocopia de su D.N.I. a
>> la siguiente dirección: Gesdatos Software, S.L. , Paseo de la Castellana,
>> 153 bajo - 28046 (Madrid), y Avda. Cortes Valencianas num. 50, 1ºC - 46015
>> (Valencia). Asimismo, es su responsabilidad comprobar que este mensaje o
>> sus archivos adjuntos no contengan virus informáticos, y en caso que los
>> tuvieran eliminarlos.
>>
>>
>>
>>
>>
>>
Re: Swagger - API description standard. Relevant for Restful Objects?
Posted by Martin Grigorov <mg...@apache.org>.
Here is a short discussion at Maven users@ about Swagger and similar
solutions: http://markmail.org/message/qpmeley7x73vba5s
Martin Grigorov
Wicket Training and Consulting
https://twitter.com/mtgrigorov
2014-12-15 16:44 GMT+02:00 GESCONSULTOR - Óscar Bou <o....@gesconsultor.com>
:
>
> Simply to comment.
>
> On [1] seems that Apache Camel latest release also documents its API using
> Swagger.
>
> Regards,
>
> Oscar
>
> [1] http://www.infoq.com/news/2014/10/apache-camel-2.14
>
>
> El 25/9/2014, a las 15:26, Dan Haywood <da...@haywood-associates.co.uk>
> escribió:
>
> yeah, looks really nice, Swagger. Have made a note.
>
> On 12 September 2014 07:11, QUALITEC - Óscar Bou <ob...@qualitec.es> wrote:
>
>
> Hi to all,
>
> I've just recently discovered the Swagger specification.
>
> There's an intro here [1], the full specification implementation can be
> found on [2] and a good example at [3].
>
> It seems a commonly accepted way to describe REST-based APIs.
>
> So perhaps it could be a great complement to current RestfulObjects
> specification.
>
> Regards,
>
> Oscar
>
>
>
>
> [1]
>
> http://www.infoworld.com/t/web-services/swagger-aims-become-the-de-facto-standard-apis-250196?source=IFWNLE_nlt_stradev_2014-09-11
>
> [2] https://github.com/wordnik/swagger-spec
>
> [3] http://petstore.swagger.wordnik.com
>
>
>
> Óscar Bou Bou
> Responsable de Producto
> Auditor Jefe de Certificación ISO 27001 en BSI
> CISA, CRISC, APMG ISO 20000, ITIL-F
>
> 902 900 231 / 620 267 520
> http://www.twitter.com/oscarbou
>
> http://es.linkedin.com/in/oscarbou
>
> http://www.GesConsultor.com <http://www.gesconsultor.com/>
>
>
>
> Este mensaje y los ficheros anexos son confidenciales. Los mismos
> contienen información reservada que no puede ser difundida. Si usted ha
> recibido este correo por error, tenga la amabilidad de eliminarlo de su
> sistema y avisar al remitente mediante reenvío a su dirección electrónica;
> no deberá copiar el mensaje ni divulgar su contenido a ninguna persona.
> Su dirección de correo electrónico junto a sus datos personales constan en
> un fichero titularidad de Gesdatos Software, S.L. cuya finalidad es la de
> mantener el contacto con Ud. Si quiere saber de qué información disponemos
> de Ud., modificarla, y en su caso, cancelarla, puede hacerlo enviando un
> escrito al efecto, acompañado de una fotocopia de su D.N.I. a la siguiente
> dirección: Gesdatos Software, S.L. , Paseo de la Castellana, 153 bajo -
> 28046 (Madrid), y Avda. Cortes Valencianas num. 50, 1ºC - 46015 (Valencia).
> Asimismo, es su responsabilidad comprobar que este mensaje o sus archivos
> adjuntos no contengan virus informáticos, y en caso que los tuvieran
> eliminarlos.
>
>
>
>
>
>
Re: Swagger - API description standard. Relevant for Restful Objects?
Posted by GESCONSULTOR - Óscar Bou <o....@gesconsultor.com>.
Simply to comment.
On [1] seems that Apache Camel latest release also documents its API using Swagger.
Regards,
Oscar
[1] http://www.infoq.com/news/2014/10/apache-camel-2.14
> El 25/9/2014, a las 15:26, Dan Haywood <da...@haywood-associates.co.uk> escribió:
>
> yeah, looks really nice, Swagger. Have made a note.
>
> On 12 September 2014 07:11, QUALITEC - Óscar Bou <ob...@qualitec.es> wrote:
>
>>
>> Hi to all,
>>
>> I've just recently discovered the Swagger specification.
>>
>> There's an intro here [1], the full specification implementation can be
>> found on [2] and a good example at [3].
>>
>> It seems a commonly accepted way to describe REST-based APIs.
>>
>> So perhaps it could be a great complement to current RestfulObjects
>> specification.
>>
>> Regards,
>>
>> Oscar
>>
>>
>>
>>
>> [1]
>> http://www.infoworld.com/t/web-services/swagger-aims-become-the-de-facto-standard-apis-250196?source=IFWNLE_nlt_stradev_2014-09-11
>>
>> [2] https://github.com/wordnik/swagger-spec
>>
>> [3] http://petstore.swagger.wordnik.com
Óscar Bou Bou
Responsable de Producto
Auditor Jefe de Certificación ISO 27001 en BSI
CISA, CRISC, APMG ISO 20000, ITIL-F
902 900 231 / 620 267 520
http://www.twitter.com/oscarbou <http://www.twitter.com/oscarbou>
http://es.linkedin.com/in/oscarbou <http://es.linkedin.com/in/oscarbou>
http://www.GesConsultor.com <http://www.gesconsultor.com/>
Este mensaje y los ficheros anexos son confidenciales. Los mismos contienen información reservada que no puede ser difundida. Si usted ha recibido este correo por error, tenga la amabilidad de eliminarlo de su sistema y avisar al remitente mediante reenvío a su dirección electrónica; no deberá copiar el mensaje ni divulgar su contenido a ninguna persona.
Su dirección de correo electrónico junto a sus datos personales constan en un fichero titularidad de Gesdatos Software, S.L. cuya finalidad es la de mantener el contacto con Ud. Si quiere saber de qué información disponemos de Ud., modificarla, y en su caso, cancelarla, puede hacerlo enviando un escrito al efecto, acompañado de una fotocopia de su D.N.I. a la siguiente dirección: Gesdatos Software, S.L. , Paseo de la Castellana, 153 bajo - 28046 (Madrid), y Avda. Cortes Valencianas num. 50, 1ºC - 46015 (Valencia). Asimismo, es su responsabilidad comprobar que este mensaje o sus archivos adjuntos no contengan virus informáticos, y en caso que los tuvieran eliminarlos.
Re: Swagger - API description standard. Relevant for Restful Objects?
Posted by Dan Haywood <da...@haywood-associates.co.uk>.
yeah, looks really nice, Swagger. Have made a note.
On 12 September 2014 07:11, QUALITEC - Óscar Bou <ob...@qualitec.es> wrote:
>
> Hi to all,
>
> I've just recently discovered the Swagger specification.
>
> There's an intro here [1], the full specification implementation can be
> found on [2] and a good example at [3].
>
> It seems a commonly accepted way to describe REST-based APIs.
>
> So perhaps it could be a great complement to current RestfulObjects
> specification.
>
> Regards,
>
> Oscar
>
>
>
>
> [1]
> http://www.infoworld.com/t/web-services/swagger-aims-become-the-de-facto-standard-apis-250196?source=IFWNLE_nlt_stradev_2014-09-11
>
> [2] https://github.com/wordnik/swagger-spec
>
> [3] http://petstore.swagger.wordnik.com