Skip to content

/ swagger-ui

Swagger UI is a collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
swagger swagger-ui swagger-api swagger-js rest rest-api openapi-specification oas openapi openapi3
JavaScript CSS HTML Other
  1. JavaScript 93.5%
  2. CSS 4.9%
  3. HTML 1.1%
  4. Other 0.5%
Branch: master
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Latest commit

@swaggerhub-bot
swaggerhub-bot release: v3.26.1
Latest commit 9a0927b Jun 11, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github housekeeping: silence lock bot for initial wave of actions (#5439) Jul 2, 2019
dev-helpers improvement: oauth "scopes" improvements (#6037) Jun 10, 2020
dist release: v3.26.1 Jun 11, 2020
docker fix(Markdown): render markdown in more secure way Jun 11, 2020
docs fix(Markdown): render markdown in more secure way Jun 11, 2020
flavors/swagger-ui-react fix: set default supportedSubmitMethods (#6030) Jun 3, 2020
release housekeeping: update release-it config (#6009) May 14, 2020
src fix(Markdown): render markdown in more secure way Jun 11, 2020
swagger-ui-dist-package Maintain backwards compatibility with absolutePath Jul 15, 2017
test fix(Markdown): render markdown in more secure way Jun 11, 2020
webpack housekeeping: `@kyleshockey/js-yaml` -> `js-yaml` (via #5511) Jul 31, 2019
.agignore add .aignore Oct 25, 2017
.babelrc bug: enum Select crashes when selecting the empty value (via #5463) Jul 13, 2019
.dockerignore feature: full-spectrum runtime Docker configuration (via #4965) Nov 1, 2018
.editorconfig Create .editorconfig Mar 20, 2017
.eslintrc housekeeping: `.js` -> `.jsx` file extensions (via #5014) Nov 8, 2018
.gitattributes Set EOL of docker-run.sh to LF May 8, 2017
.gitignore feature: `swagger-ui-react` module (via #5207) Mar 2, 2019
.npmignore improve(npm-module): include standalone preset in `swagger-ui` (#4101) Jan 12, 2018
.npmrc chore(package): freeze release-it library and it's deps Jun 10, 2020
.prettierrc.yaml feat: Multiple Examples for OpenAPI 3 Parameters, Request Bodies, and… Jun 29, 2019
Dockerfile add swagger url option (#6122) Jun 9, 2020
LICENSE Use official apache 2.0 license text (#5470) Jan 9, 2020
README.md No more IE11 Jan 22, 2020
SECURITY.md housekeeping: create `.github/SECURITY.md` (via #5514) Aug 2, 2019
composer.json Update composer.json Apr 4, 2017
cypress.json housekeeping: automated releases via `release-it` (via #4875) Sep 13, 2018
package-lock.json release: v3.26.1 Jun 11, 2020
package.json release: v3.26.1 Jun 11, 2020
renovate.json chore(package): freeze release-it library and it's deps Jun 10, 2020
snapcraft.yaml Add the daemon Jan 14, 2017
swagger-config.yaml improvement: `online.swagger.io` -> `validator.swagger.io` (#5599) Sep 10, 2019

README.md

NPM version Build Status npm audit total GitHub contributors

monthly npm installs total docker pulls monthly packagist installs gzip size

👉🏼 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 to three different NPM modules:

  • swagger-ui is a traditional npm module intended for use in single-page applications that are capable of resolving dependencies (via Webpack, Browserify, etc).
  • swagger-ui-dist is a dependency-free module that includes everything you need to serve Swagger UI in a server-side project, or a single-page application that can't resolve npm module dependencies.
  • swagger-ui-react is Swagger UI packaged as a React component for use in React applications.

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.

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
3.18.3 2018-08-03 2.0, 3.0 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

Documentation

Usage

Customization

Development

Integration Tests

You will need JDK of version 7 or higher as instructed here https://nightwatchjs.org/gettingstarted/#selenium-server-setup

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 collectionFormat is 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.

You can’t perform that action at this time.