Universal baseline for API docs. v5.32.1 released Mar 2026. OpenAPI 3.1.2 support. 389 contributors.
Swagger UI
activeThe original interactive API documentation renderer. 28.7K stars, 603K npm/week combined. Actively maintained with weekly releases (v5.32.1, Mar 2026). OpenAPI 3.1.2 support. The universal baseline.
Where it wins
Universal standard — every API docs tool benchmarks against it
28.7K stars, 603K npm/week combined (react + vanilla)
Actively maintained — weekly releases, v5.32.1 Mar 2026
OpenAPI 3.1.2 support
Free and open-source
Where to be skeptical
Hasn't innovated in years — reliable but basic
No SDK generation, no governance features
1,376 open issues — high maintenance burden
No AI features or modern DX improvements
Editorial verdict
The universal baseline for API documentation. 28.7K stars, 603K npm/week combined. Actively maintained with weekly releases. Every API docs tool benchmarks against Swagger UI. Reliable and free but hasn't innovated in years. If you need more than basic OpenAPI rendering, look at Fern or Redocly.
Related
Docusaurus
92Meta's open-source docs framework. Largest community (64K stars, 765K npm/week), built-in versioned docs, massive plugin ecosystem. The incumbent safe default for large OSS projects.
MkDocs Material
92Python ecosystem's default docs framework. 26.3K stars, 4.2M PyPI weekly downloads (highest of ANY docs tool). Now in maintenance mode — creator building Zensical as successor with 4-5x faster builds.
Astro Starlight
91Astro-based docs framework shipping zero client-side JS by default. Go-compiled dev server, multi-framework component support (React, Svelte, Vue, Solid). The DX leader for content-first documentation.
Fumadocs
90Next.js docs framework with headless component architecture, built-in OpenAPI rendering, and Orama-powered full-text search. Fastest-growing docs framework (3x YoY).
Public evidence
Raw GitHub source
GitHub README peek
Constrained peek so you can sanity-check the source material without leaving the site.
<img src="https://raw.githubusercontent.com/swagger-api/swagger.io/wordpress/images/assets/SWU-logo-clr.png" width="300">
Introduction
Swagger UI allows anyone — be it your development team or your end consumers — to visualize and interact with the API’s resources without having any of the implementation logic in place. It’s automatically generated from your OpenAPI (formerly known as Swagger) Specification, with the visual documentation making it easy for back end implementation and client side consumption.
General
👉🏼 Want to score an easy open-source contribution? Check out our Good first issue label.
🕰️ Looking for the older version of Swagger UI? Refer to the 2.x branch.
This repository publishes three different NPM modules:
We strongly suggest that you use swagger-ui instead of swagger-ui-dist if you're building a single-page application, since swagger-ui-dist is significantly larger.
If you are looking for plain ol' HTML/JS/CSS, download the latest release and copy the contents of the /dist folder to your server.
Compatibility
The OpenAPI Specification has undergone 5 revisions since initial creation in 2010. Compatibility between Swagger UI and the OpenAPI Specification is as follows:
| Swagger UI Version | Release Date | OpenAPI Spec compatibility | Notes |
|---|---|---|---|
| 5.32.0 | 2026-02-27 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.0.4, 3.1.0, 3.1.1, 3.1.2, 3.2.0 | tag v5.32.0 |
| 5.19.0 | 2025-02-17 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.0.4, 3.1.0, 3.1.1, 3.1.2 | tag v5.19.0 |
| 5.0.0 | 2023-06-12 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0 | tag v5.0.0 |
| 4.0.0 | 2021-11-03 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | tag v4.0.0 |
| 3.18.3 | 2018-08-03 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | tag v3.18.3 |
| 3.0.21 | 2017-07-26 | 2.0 | tag v3.0.21 |
| 2.2.10 | 2017-01-04 | 1.1, 1.2, 2.0 | tag v2.2.10 |
| 2.1.5 | 2016-07-20 | 1.1, 1.2, 2.0 | tag v2.1.5 |
| 2.0.24 | 2014-09-12 | 1.1, 1.2 | tag v2.0.24 |
| 1.0.13 | 2013-03-08 | 1.1, 1.2 | tag v1.0.13 |
| 1.0.1 | 2011-10-11 | 1.0, 1.1 | tag v1.0.1 |
Anonymized analytics
SwaggerUI uses Scarf to collect anonymized installation analytics. These analytics help support the maintainers of this library and ONLY run during installation. To opt out, you can set the scarfSettings.enabled field to false in your project's package.json:
// package.json
{
// ...
"scarfSettings": {
"enabled": false
}
// ...
}
Alternatively, you can set the environment variable SCARF_ANALYTICS to false as part of the environment that installs your npm packages, e.g., SCARF_ANALYTICS=false npm install.
Documentation
Usage
- Installation
- Configuration
- CORS
- OAuth2
- Deep Linking
- Limitations
- Version detection
Customization
- Overview
- Plugin API
- Custom layout
Development
- Setting up
- Scripts
Contributing
- Contributing
Integration Tests
You will need JDK of version 7 or higher as instructed here https://nightwatchjs.org/guide/getting-started/installation.html#install-selenium-server
Integration tests can be run locally with npm run e2e - be sure you aren't running a dev server when testing!
Browser support
Swagger UI works in the latest versions of Chrome, Safari, Firefox, and Edge.
Known Issues
To help with the migration, here are the currently known issues with 3.X. This list will update regularly, and will not include features that were not implemented in previous versions.
- Only part of the parameters previously supported are available.
- The JSON Form Editor is not implemented.
- Support for
collectionFormatis partial. - l10n (translations) is not implemented.
- Relative path support for external files is not implemented.
Security contact
Please disclose any security-related issues or vulnerabilities by emailing security@swagger.io, instead of using the public issue tracker.
License
SwaggerUI is licensed under Apache 2.0 license. SwaggerUI comes with an explicit NOTICE file containing additional legal notices and information.