Skip to Content

Using Swagger/OpenAPI to describe and discover SAP Gateway/OData API?

Oct 17, 2016 at 07:15 PM


avatar image
Former Member

Currently, the only way to get information from an API developed with the Gateway Builder is using the OData $metadata parameter. Another popular option for describing and discovering a RESTful service is Swagger, now part of the Open API initiative (of which Microsoft is a member, but looks like SAP is not (yet)).

I saw on the OASIS standards committee web page that Swagger will be an alternative to describe OData metadata in JSON format:

When will SAP support this?

BTW, I found a node module that can be used to convert an existing OData metadata to the Open API format:

- Guy

10 |10000 characters needed characters left characters exceeded
* Please Login or Register to Answer, Follow or Comment.

1 Answer

avatar image
Former Member
Dec 01, 2016 at 10:12 AM

Hi Guy,

we are actually working right now on the SAP API Designer (as part of the API Management). As part of this designer (based on the Swagger Editor) we have implemented a feature to convert your $metadata into a OpenAPI format.

Feel free to check out the API Designer from your HCP Trial instance -> Services -> API Management (you might need to activate SAP API management first, Free Trial of SAP API Management on HANA Cloud Platform is available now!)

Hope this helps,


apidesigner.jpg (32.2 kB)
pasteodata.png (27.4 kB)
10 |10000 characters needed characters left characters exceeded