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

[former_member187738]

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: https://issues.oasis-open.org/browse/ODATA-907

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: https://www.npmjs.com/package/odata2openapi

- Guy

[Former Member]

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,

Holger.