swagger-ui

Fork of https://github.com/swagger-api/swagger-ui

swaggerhub-bot 080c70ae76 release: v3.20.9		vor 5 Jahren
.github	housekeeping: remove Q&A section from feature template (#4708)	vor 6 Jahren
dev-helpers	improvement: prevent loading resources from third party CDN (via #4598)	vor 6 Jahren
dist	release: v3.20.9	vor 5 Jahren
docker	improvement(docker): avoid caching mounted json/yml/yaml assets (via #5151)	vor 5 Jahren
docs	housekeeping: losslessly crush PNG images with pingo (via #5158)	vor 5 Jahren
release	housekeeping: drop `v` from GitHub Release titles (via #4882)	vor 6 Jahren
src	fix: type safety for operation summary handling (via #5191)	vor 5 Jahren
swagger-ui-dist-package	Maintain backwards compatibility with absolutePath	vor 7 Jahren
test	fix: type safety for operation summary handling (via #5191)	vor 5 Jahren
.agignore	add .aignore	vor 7 Jahren
.babelrc	housekeeping: bundle size reductions (#4713)	vor 6 Jahren
.dockerignore	feature: full-spectrum runtime Docker configuration (via #4965)	vor 5 Jahren
.editorconfig	Create .editorconfig	vor 7 Jahren
.eslintrc	housekeeping: `.js` -> `.jsx` file extensions (via #5014)	vor 5 Jahren
.gitattributes	Set EOL of docker-run.sh to LF	vor 7 Jahren
.gitignore	meta: introduce Cypress end-to-end testing (via #4827)	vor 6 Jahren
.npmignore	improve(npm-module): include standalone preset in `swagger-ui` (#4101)	vor 6 Jahren
CONTRIBUTING.md	docs(contributing): add merging pull requests section (#4076)	vor 6 Jahren
Dockerfile	improvement(docker): smaller images via no-cache option (via #5157)	vor 5 Jahren
LICENSE	housekeeping: happy new year! (via #5102)	vor 5 Jahren
README.md	housekeeping: add React compatibility issue to readme (via #5141)	vor 5 Jahren
composer.json	Update composer.json	vor 7 Jahren
cypress.json	housekeeping: automated releases via `release-it` (via #4875)	vor 6 Jahren
make-webpack-config.js	housekeeping: branding updates (via #5084)	vor 5 Jahren
package-lock.json	release: v3.20.9	vor 5 Jahren
package.json	release: v3.20.9	vor 5 Jahren
postcss.config.js	Fixes #3334 - Add autoprefixer back to postcss plugins	vor 7 Jahren
snapcraft.yaml	Add the daemon	vor 7 Jahren
swagger-config.yaml	improvement: generate default oauth2RedirectUrl based on page location (via #5085)	vor 5 Jahren
webpack-dist-bundle.config.js	build(umd-module): prevent mangling (#4320)	vor 6 Jahren
webpack-dist-standalone.config.js	build(umd-module): prevent mangling (#4320)	vor 6 Jahren
webpack-dist.config.js	Revert "initial perf, which gets stripped out in production (#4131)" (#4636)	vor 6 Jahren
webpack-hot-dev-server.config.js	Revert "initial perf, which gets stripped out in production (#4131)" (#4636)	vor 6 Jahren
webpack-watch.config.js	Revert "initial perf, which gets stripped out in production (#4131)" (#4636)	vor 6 Jahren
webpack.check.js	Fixes #3329 - Tweak webpack config to share CSS loaders for production builders. Updated production builds to use `ExtractTextPlugin` so styles are not built into JS.	vor 7 Jahren
webpack.config.js	Fixes #3329 - Tweak webpack config to share CSS loaders for production builders. Updated production builds to use `ExtractTextPlugin` so styles are not built into JS.	vor 7 Jahren
webpack.dist-style.config.js	Moved split-pane-mode.less file into a .scss file. Removed remaining unused .less files. Removed reference to less file in webpack config. Removed dependency on less-loader. Updated standalone and bundle builds to no longer compile any styles.	vor 7 Jahren

README.md

👉🏼 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.
There are compatibility issues with React 16.x.

Security contact

Please disclose any security-related issues or vulnerabilities by emailing security@swagger.io, instead of using the public issue tracker.

License

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.