About Swagger UI
Swagger UI is an open source tool that displays an API's documentation as an interactive page. It is generated from an OpenAPI specification, so the page reflects the description your API already has.
What it does
You point Swagger UI at an OpenAPI 3 or Swagger 2.0 definition, and it renders each endpoint with its parameters and responses. Visitors can send requests from the page to see how the API behaves. It works in the browser on its own, so it does not need your API implementation running to show the documentation, and you can embed it in your own site.
Key features
- Render endpoints from an OpenAPI file
- Try out requests directly in the browser
- Support for Swagger 2.0 and OpenAPI 3 files
- Customize styles with full source access
- Run locally or on a web page
Who it's for
Swagger UI suits backend teams that publish public or internal APIs, and client developers who need to explore them. It is a useful choice when your API already has an OpenAPI description and you want readable reference documentation without writing it by hand.
Pricing and good to know
Swagger UI is open source under the Apache-2.0 license, so it is free to use. The Swagger company also offers hosted tools such as Swagger Studio, along with team and enterprise plans that have their own pricing. Those commercial options are separate from the open source project.
Highlights
- Render each endpoint from an OpenAPI file
- Send test requests from the documentation page
- Read Swagger 2.0 and OpenAPI 3 definitions
- Change the look with the full source code
- Embed the docs in your own web page
