In the Petstore example, the site is generated using Swagger UI.īefore making any requests, you would normally authorize your session by clicking the Authorize button and completing the information required in the Authorization modal pictured below: To get a better understanding of Swagger UI, let’s explore the Swagger Petstore example. Get familiar with Swagger UI through the Petstore demo Additionally, Swagger UI (which is an actively managed project with an Apache 2.0 license) supports the latest version of the OpenAPI spec (3.x) and integrates with other Swagger tooling.įor definitions of common terms, see Key terms at the end of this article. Swagger UI generates an interactive API console for users to quickly learn about your API and experiment with requests. Swagger UI is one of the most popular tools for generating interactive documentation from your OpenAPI document.
The following tutorial shows you how to integrate an OpenAPI specification document into Swagger UI.įor a more conceptual overview of OpenAPI and Swagger, see Introduction to the OpenAPI specification, or see this article I wrote for ISTC a few years ago: Implementing Swagger with API docs (PDF). Swagger UI provides a display framework that reads an OpenAPI specification document and generates an interactive documentation website.