Overview
Swagger UI visualizes OpenAPI endpoints, parameters, and schemas and can let users execute requests from the browser. It can be integrated through npm modules, a React component, static assets, or a Docker image.
Features and best fit
Based on official documentation; not hands-on tested · Content checked:
Generate interactive documentation from OpenAPI definitions
OpenAPI definitions become navigable endpoint and schema documentation with optional in-browser request execution.
Choose npm, React, static assets, or Docker distribution
Different package forms support bundled SPAs, React applications, server-served assets, and standalone container deployment.
For publishing OpenAPI contracts to API consumers
It fits teams that use OpenAPI as a shared contract and want consumers to browse and try the documented API.
Sources: [2]
Review exposure, CORS, OAuth, and analytics configuration
Try-it-out flows depend on CORS and authentication setup. Also verify which endpoints and schemas should be public and whether Scarf analytics should be disabled.
Official sources
- [1]swagger-api/swagger-ui repository(2026-09-21)
- [2]Swagger UI README(2026-09-21)
- [3]Swagger UI installation guide(2026-09-21)
- [4]swagger-ui package(2026-09-21)
- [5]Swagger UI Apache-2.0 license(2026-09-21)
Supplemental curator note
Swagger UI is currently 5.33.0 and its compatibility table includes OpenAPI 3.2.0. It ships as `swagger-ui`, `swagger-ui-dist`, and `swagger-ui-react`; the README generally recommends `swagger-ui` for SPAs when bundling is available. npm installation includes anonymous Scarf analytics, which can be disabled.
Try it in 3 steps
- 1
Pull the official Docker image
Use the prebuilt image from the official installation guide.
docker pull docker.swagger.io/swaggerapi/swagger-ui - 2
Start it with the Petstore OpenAPI definition
Point Swagger UI at an external OpenAPI URL and run it locally.
docker run --rm -p 80:8080 -e SWAGGER_JSON_URL=https://petstore3.swagger.io/api/v3/openapi.json docker.swagger.io/swaggerapi/swagger-ui - 3
Open the UI
Inspect endpoints, schemas, and Try it out before replacing the sample with your own API definition.
http://localhost/
Growth
Growth trends · Last 30 days
29,013 Stars
Trend data is still being collected.
Development activity
Last 90 days · weekly
- Commits (last 30 days)
- 27
- Open PRs
- 166
Development activity is still being collected.
Built with
Categories and tags
Categories
GitHub data
GitHub dataView detailed GitHub data
GitHub Topics
- swagger
- swagger-ui
- swagger-api
- rest
- rest-api
- openapi-specification
- oas
- openapi
- openapi3
- hacktoberfest
- openapi31
- open-source
- Stars
- 29,013
- Forks
- 9,257
- Watchers
- 623
- Open issues
- 963
- Contributors
- 390
- Primary language
- JavaScript
- License
- Apache-2.0
- Repository last updated
- Sep 21, 2026
Related information
Write a related articleShare a guide or use case for this OSS in Markdown. Articles are published after administrator approval.
Explore next
- Axios109,206 Stars
1 shared tag(s) · 1 shared category(s) · Same language
A Promise-based HTTP client for browsers and Node.js with interceptors, adapters, cancellation, and transport controls.
JavaScript - Bruno47,082 Stars
1 shared tag(s) · 1 shared category(s) · Same language
An offline-first API client and testing IDE that stores collections as local text files and collaborates through Git instead of cloud sync.
JavaScript - FastAPI102,494 Stars
1 shared tag(s) · 1 shared category(s)
A Python web framework that derives validation, OpenAPI, and interactive API docs from type hints.
Python - PocketBase61,120 Stars
1 shared tag(s) · 1 shared category(s)
A self-hostable Go backend combining SQLite, realtime data, auth, files, admin UI, and APIs.
Go - OpenAPI Generator26,751 Stars
1 shared tag(s) · 1 shared category(s)
A code generator that turns OpenAPI definitions into API client SDKs, server stubs, documentation, and configuration for many languages and frameworks.
Java
Report incorrect information
Tell us if any listing information is incorrect or outdated.