in the SAP API Business Hub you can find the OpenAPI spec for the APIs exposed by the different products. SAP has adopted the OpenAPI spec to document its APIs, e.g. The OpenAPI specification is an industry standard, it is widely adopted by different vendors/services to document their APIs and there is a large community behind it. Swagger UI in SAP Ariba Developer Portal Why is it important? Unfortunately, people commonly refer to Swagger UI as just Swagger which can be confusing at times. You can see a Swagger UI in the SAP Ariba Developer Portal or in the API Business Hub Enterprise. Swagger UI is commonly embedded in products, to allow developers to test the APIs that they publish.

One of its most popular tools, and one that you’ve probably seen around, is Swagger UI.

Swagger is a collection of tools for API development created by SmartBear Software. The proper name is OpenAPI, not Swagger or Open API, and it is how I will refer to it in this blog post. You might bump into some websites/documentation that still refers to the specification as Swagger or use Swagger and OpenAPI spec interchangeably. Before this, it was known as Swagger specification. The OpenAPI specification was donated to the Linux Foundation under the OpenAPI Initiative back in 2015. In simple terms, the specification is a document that describes an API. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.Īn OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases. The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. OpenAPI Initiative What is an OpenAPI specification (OAS)?įrom the OpenAPI specification, Introduction section – … In this blog post, I will cover what the OpenAPI specification is, how different SAP products have adopted OpenAPI specification, how you can get started, which tools you can use, and how you can document your existing APIs without much effort.

Ariba rest api