Repolode
Submit
swagger-api

swagger-api/swagger-ui

Swagger UI generates interactive API documentation in the browser from an OpenAPI specification file.

Open-source alternative to:PostmanReadMe

View on GitHubWebsite
Stars
29,040
Forks
9,250
Open issues
1,144
Last commit
2 days ago

What is it?

Swagger UI is a set of HTML, JavaScript, and CSS assets that render an OpenAPI (formerly Swagger) specification as a browsable documentation page. Developers and API consumers can see every endpoint, its parameters and response shapes, and send test requests directly from the page without writing client code first.

The project is published in three forms: the swagger-ui npm module for single-page apps with a bundler, swagger-ui-dist, a dependency-free bundle for servers or apps that cannot resolve npm dependencies, and swagger-ui-react, a React component. Plain HTML, JS, and CSS files from the dist folder can also be copied onto any web server.

The current release supports OpenAPI 2.0 through 3.2.0, along with a range of 3.x minor versions. It runs in the latest versions of Chrome, Safari, Firefox, and Edge.

Key features

  • 01Renders OpenAPI and Swagger specifications as interactive documentation pages.
  • 02Lets users send test requests to endpoints directly from the browser.
  • 03Ships as an npm module, a dependency-free dist bundle, and a React component.
  • 04Supports OAuth2 authorization and deep linking to specific operations.
  • 05Can be customized through configuration, a plugin API, and a custom layout.

Use cases

  • Publishing API reference documentation for a backend service to internal or external consumers.
  • Letting frontend and mobile teams explore an API before writing client code.
  • Embedding interactive API docs inside a React application.
  • Serving static API docs from a server that cannot install npm dependencies.

Topics

#openapi#swagger#api-documentation#rest-api#javascript#api-testing#hacktoberfest#oas#open-source#openapi-specification

FAQ

What is swagger-ui?
Swagger UI generates interactive API documentation in the browser from an OpenAPI specification file. Swagger UI is a set of HTML, JavaScript, and CSS assets that render an OpenAPI (formerly Swagger) specification as a browsable documentation page. Developers and API consumers can see every endpoint, its parameters and response shapes, and send test requests directly from the page without writing client code first.
Is swagger-ui free to use? What license does it have?
swagger-ui is open source under the Apache-2.0 license. Check the license terms before using it in commercial products.
Is swagger-ui still maintained?
Actively maintained. The last commit to swagger-ui was on Oct 16, 2026.
What can I use swagger-ui for?
Publishing API reference documentation for a backend service to internal or external consumers. Letting frontend and mobile teams explore an API before writing client code. Embedding interactive API docs inside a React application. Serving static API docs from a server that cannot install npm dependencies.
Where can I get swagger-ui?
The source code and installation instructions are on GitHub: https://github.com/swagger-api/swagger-ui

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects