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

kyle 2669b26dcb housekeeping: update model wrapper selector in Selenium tests (via #5064 )		5 年之前
.github	housekeeping: remove Q&A section from feature template (#4708)	6 年之前
dev-helpers	improvement: prevent loading resources from third party CDN (via #4598)	6 年之前
dist	release: v3.20.1	5 年之前
docker	improve(docker): bail out + provide helpful error if injection fails (via #5007)	5 年之前
docs	docs(installation): fix link to configuration.md (via #5009)	5 年之前
release	housekeeping: drop `v` from GitHub Release titles (via #4882)	6 年之前
src	improve: showing showing server description in dropdown (via #5015)	5 年之前
swagger-ui-dist-package	Maintain backwards compatibility with absolutePath	7 年之前
test	housekeeping: update model wrapper selector in Selenium tests (via #5064)	5 年之前
.agignore	add .aignore	7 年之前
.babelrc	housekeeping: bundle size reductions (#4713)	6 年之前
.dockerignore	feature: full-spectrum runtime Docker configuration (via #4965)	5 年之前
.editorconfig	Create .editorconfig	7 年之前
.eslintrc	housekeeping: `.js` -> `.jsx` file extensions (via #5014)	5 年之前
.gitattributes	Set EOL of docker-run.sh to LF	7 年之前
.gitignore	meta: introduce Cypress end-to-end testing (via #4827)	6 年之前
.npmignore	improve(npm-module): include standalone preset in `swagger-ui` (#4101)	6 年之前
CONTRIBUTING.md	docs(contributing): add merging pull requests section (#4076)	6 年之前
Dockerfile	feature: Docker OAuth block support (via #4987)	5 年之前
LICENSE	Happy new year 🎉	6 年之前
README.md	release: 3.18.3 (via #4860)	6 年之前
composer.json	Update composer.json	7 年之前
cypress.json	housekeeping: automated releases via `release-it` (via #4875)	6 年之前
make-webpack-config.js	meta: introduce Cypress end-to-end testing (via #4827)	6 年之前
package-lock.json	housekeeping: remove Topbar CWM & unneeded empty lines (via #5018)	5 年之前
package.json	release: v3.20.1	5 年之前
postcss.config.js	Fixes #3334 - Add autoprefixer back to postcss plugins	7 年之前
snapcraft.yaml	Add the daemon	7 年之前
swagger-config.yaml	use HTTPS for Petstore by default (#4652)	6 年之前
webpack-dist-bundle.config.js	build(umd-module): prevent mangling (#4320)	6 年之前
webpack-dist-standalone.config.js	build(umd-module): prevent mangling (#4320)	6 年之前
webpack-dist.config.js	Revert "initial perf, which gets stripped out in production (#4131)" (#4636)	6 年之前
webpack-hot-dev-server.config.js	Revert "initial perf, which gets stripped out in production (#4131)" (#4636)	6 年之前
webpack-watch.config.js	Revert "initial perf, which gets stripped out in production (#4131)" (#4636)	6 年之前
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.	7 年之前
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.	7 年之前
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.	7 年之前

README.md

Swagger UI

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

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.