You are viewing a plain text version of this content. The canonical link for it is here.
Posted to user@olingo.apache.org by "Tuo, Erming" <er...@sap.com> on 2015/09/02 21:46:46 UTC
FW: Swagger for APIs
Olingo team,
Is it possible to include some framework like Swagger for API documentations? Any thoughts or plans?
Thx
Erming
From: <Mehaffey>, Dan <da...@sap.com>>
Date: Wednesday, September 2, 2015 at 3:33 PM
To: SAP AG <er...@sap.com>>
Subject: Swagger for APIs
FYI: other areas of our group are looking at Swagger to define APIs:
http://swagger.io/
We in Docs are very keen on this for obvious reasons – a Swagger definition is not only human-readable but can also generate documentation in a Doxygen or Javadoc way.
Dan
Re: Swagger for APIs
Posted by Anil G <gv...@gmail.com>.
We actually implemented swagger.json support on our odata services
ourselves. Swagger is currently the most popular json based service
description format for REST services so it makes sense that OData uses
swagger 2.0 rather than re-inventing the wheel.
On Thu, Sep 3, 2015 at 1:38 AM, Handl, Ralf <ra...@sap.com> wrote:
> Hi Erming,
>
>
>
> The OASIS OData Technical Committee is currently defining a JSON format
> for OData $metadata based on JSON Schema. Now Swagger as well as RAML are
> also using JSON Schema to describe request and response payloads, so we’ve
> investigated how we could leverage them to describe OData services.
>
>
>
> One by-product of that investigation is an experimental “OData V4 to
> Swagger” XSL transformation, available at
> https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/examples/V4-CSDL-to-Swagger.xsl.
>
>
>
>
> This is far from complete, but the results look rather promising, so I’d
> be happy if someone would pursue this topic further.
>
>
>
> Thanks in advance!
>
> --Ralf
>
>
>
> *From:* Bolz, Michael [mailto:michael.bolz@sap.com]
> *Sent:* Donnerstag, 3. September 2015 06:57
> *To:* user@olingo.apache.org
> *Cc:* Mehaffey, Dan <da...@sap.com>
> *Subject:* Re: Swagger for APIs
>
>
>
> Hi Erming,
>
>
>
> I’am not familiar with Swagger but as far as I understand it it should be
> possible to include such a framework.
>
> However I didn’t know about any thoughts in doing this.
>
> Current focus for Olingo is to get our first stable V4 release ;o)
>
>
>
> If you start an integration of Swagger the community is surely interested
> to hear about it.
>
>
>
> Best Regards,
>
> Michael
>
>
>
>
>
> On 02 Sep 2015, at 21:46, Tuo, Erming <er...@sap.com> wrote:
>
>
>
> Olingo team,
>
>
>
> Is it possible to include some framework like Swagger for API
> documentations? Any thoughts or plans?
>
>
>
> Thx
>
>
>
> Erming
>
>
>
> *From: *<Mehaffey>, Dan <da...@sap.com>
> *Date: *Wednesday, September 2, 2015 at 3:33 PM
> *To: *SAP AG <er...@sap.com>
> *Subject: *Swagger for APIs
>
>
>
> FYI: other areas of our group are looking at Swagger to define APIs:
>
> http://swagger.io/
>
>
>
> We in Docs are very keen on this for obvious reasons – a Swagger
> definition is not only human-readable but can also generate documentation
> in a Doxygen or Javadoc way.
>
>
>
> Dan
>
>
>
RE: Swagger for APIs
Posted by "Handl, Ralf" <ra...@sap.com>.
Hi Erming,
The OASIS OData Technical Committee is currently defining a JSON format for OData $metadata based on JSON Schema. Now Swagger as well as RAML are also using JSON Schema to describe request and response payloads, so we've investigated how we could leverage them to describe OData services.
One by-product of that investigation is an experimental "OData V4 to Swagger" XSL transformation, available at https://tools.oasis-open.org/version-control/browse/wsvn/odata/trunk/spec/examples/V4-CSDL-to-Swagger.xsl.
This is far from complete, but the results look rather promising, so I'd be happy if someone would pursue this topic further.
Thanks in advance!
--Ralf
From: Bolz, Michael [mailto:michael.bolz@sap.com]
Sent: Donnerstag, 3. September 2015 06:57
To: user@olingo.apache.org
Cc: Mehaffey, Dan <da...@sap.com>
Subject: Re: Swagger for APIs
Hi Erming,
I'am not familiar with Swagger but as far as I understand it it should be possible to include such a framework.
However I didn't know about any thoughts in doing this.
Current focus for Olingo is to get our first stable V4 release ;o)
If you start an integration of Swagger the community is surely interested to hear about it.
Best Regards,
Michael
On 02 Sep 2015, at 21:46, Tuo, Erming <er...@sap.com>> wrote:
Olingo team,
Is it possible to include some framework like Swagger for API documentations? Any thoughts or plans?
Thx
Erming
From: <Mehaffey>, Dan <da...@sap.com>>
Date: Wednesday, September 2, 2015 at 3:33 PM
To: SAP AG <er...@sap.com>>
Subject: Swagger for APIs
FYI: other areas of our group are looking at Swagger to define APIs:
http://swagger.io/
We in Docs are very keen on this for obvious reasons - a Swagger definition is not only human-readable but can also generate documentation in a Doxygen or Javadoc way.
Dan
Re: Swagger for APIs
Posted by "Bolz, Michael" <mi...@sap.com>.
Hi Erming,
I’am not familiar with Swagger but as far as I understand it it should be possible to include such a framework.
However I didn’t know about any thoughts in doing this.
Current focus for Olingo is to get our first stable V4 release ;o)
If you start an integration of Swagger the community is surely interested to hear about it.
Best Regards,
Michael
> On 02 Sep 2015, at 21:46, Tuo, Erming <er...@sap.com> wrote:
>
> Olingo team,
>
> Is it possible to include some framework like Swagger for API documentations? Any thoughts or plans?
>
> Thx
>
> Erming
>
> From: <Mehaffey>, Dan <dan.mehaffey@sap.com <ma...@sap.com>>
> Date: Wednesday, September 2, 2015 at 3:33 PM
> To: SAP AG <erming.tuo@sap.com <ma...@sap.com>>
> Subject: Swagger for APIs
>
> FYI: other areas of our group are looking at Swagger to define APIs:
> http://swagger.io/ <http://swagger.io/>
>
> We in Docs are very keen on this for obvious reasons – a Swagger definition is not only human-readable but can also generate documentation in a Doxygen or Javadoc way.
>
> Dan