Swagger UI is a collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
Clone or download
Latest commit 9a9b636 Oct 20, 2018
Permalink
Failed to load latest commit information.
.github housekeeping: remove Q&A section from feature template (#4708) Jul 9, 2018
dev-helpers improvement: prevent loading resources from third party CDN (via #4598) Jul 6, 2018
dist release: v3.19.4 Oct 20, 2018
docs Added anchors to configuration parameters (#4711) Jul 11, 2018
release housekeeping: drop `v` from GitHub Release titles (via #4882) Sep 15, 2018
src improve: deeplinking behavior (#4960) Oct 19, 2018
swagger-ui-dist-package Maintain backwards compatibility with absolutePath Jul 15, 2017
test improve: deeplinking behavior (#4960) Oct 19, 2018
.agignore add .aignore Oct 25, 2017
.babelrc housekeeping: bundle size reductions (#4713) Jul 19, 2018
.dockerignore feature(docker-image): allow custom nginx port within container (#4086) Jan 12, 2018
.editorconfig Create .editorconfig Mar 20, 2017
.eslintrc meta: introduce Cypress end-to-end testing (via #4827) Aug 23, 2018
.gitattributes Set EOL of docker-run.sh to LF May 8, 2017
.gitignore meta: introduce Cypress end-to-end testing (via #4827) Aug 23, 2018
.npmignore improve(npm-module): include standalone preset in `swagger-ui` (#4101) Jan 12, 2018
CONTRIBUTING.md docs(contributing): add merging pull requests section (#4076) Jan 6, 2018
Dockerfile fix(docker): make shell script executable (via #4876) Sep 15, 2018
LICENSE Happy new year 🎉 Jan 2, 2018
README.md release: 3.18.3 (via #4860) Sep 8, 2018
composer.json Update composer.json Apr 4, 2017
cypress.json housekeeping: automated releases via `release-it` (via #4875) Sep 13, 2018
docker-run.sh feat(docker): allow configUrl to be used in Docker (via #4881) Sep 15, 2018
make-webpack-config.js meta: introduce Cypress end-to-end testing (via #4827) Aug 23, 2018
nginx.conf Change nginx configuration based on BASE_URL, instead of moving actua… Jan 5, 2018
package-lock.json fix: inconsistent behavior with multiple invocations of SwaggerUI (via Oct 4, 2018
package.json release: v3.19.4 Oct 20, 2018
postcss.config.js Fixes #3334 - Add autoprefixer back to postcss plugins Jul 5, 2017
snapcraft.yaml Add the daemon Jan 14, 2017
swagger-config.yaml use HTTPS for Petstore by default (#4652) Jun 15, 2018
webpack-dist-bundle.config.js build(umd-module): prevent mangling (#4320) May 22, 2018
webpack-dist-standalone.config.js build(umd-module): prevent mangling (#4320) May 22, 2018
webpack-dist.config.js Revert "initial perf, which gets stripped out in production (#4131)" (#… Jun 9, 2018
webpack-hot-dev-server.config.js Revert "initial perf, which gets stripped out in production (#4131)" (#… Jun 9, 2018
webpack-watch.config.js Revert "initial perf, which gets stripped out in production (#4131)" (#… Jun 9, 2018
webpack.check.js Fixes #3329 - Tweak webpack config to share CSS loaders for producti… Jul 8, 2017
webpack.config.js Fixes #3329 - Tweak webpack config to share CSS loaders for producti… Jul 8, 2017
webpack.dist-style.config.js Moved split-pane-mode.less file into a .scss file. Removed remaining … Jul 12, 2017

README.md

Swagger UI

NPM version

👉🏼 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 two 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.

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 http://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, Edge and IE11.

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.

License

Copyright 2018 SmartBear Software

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.