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

kyle 9d02a7d8ad fix(sample-gen): respect null values in examples (via #4679 ) * improvement: re-enable and improve Models jump-to-path * fix(sample-gen): respect null values in examples		6 anni fa
.github	Issue template tweaks (#4520)	6 anni fa
dev-helpers	use HTTPS for Petstore by default (#4652)	6 anni fa
dist	v3.17.1 (#4656)	6 anni fa
docs	Doc updates	6 anni fa
src	fix(sample-gen): respect null values in examples (via #4679)	6 anni fa
swagger-ui-dist-package	Maintain backwards compatibility with absolutePath	7 anni fa
test	fix(sample-gen): respect null values in examples (via #4679)	6 anni fa
.agignore	add .aignore	7 anni fa
.babelrc	housekeeping: remove extraneous `getbase` aliases (#4671)	6 anni fa
.dockerignore	feature(docker-image): allow custom nginx port within container (#4086)	6 anni fa
.editorconfig	Create .editorconfig	7 anni fa
.eslintrc	Add ESLint rule that catches `describe.only`, `it.only`	7 anni fa
.gitattributes	Set EOL of docker-run.sh to LF	7 anni fa
.gitignore	Bug/update dependencies (#4543)	6 anni fa
.npmignore	improve(npm-module): include standalone preset in `swagger-ui` (#4101)	6 anni fa
.travis.yml	feat(rendering): gate rendering based on valid version identifiers (#4614)	6 anni fa
CONTRIBUTING.md	docs(contributing): add merging pull requests section (#4076)	6 anni fa
Dockerfile	use HTTPS for Petstore by default (#4652)	6 anni fa
LICENSE	Happy new year 🎉	6 anni fa
README.md	v3.17.1 (#4656)	6 anni fa
composer.json	Update composer.json	7 anni fa
docker-run.sh	use HTTPS for Petstore by default (#4652)	6 anni fa
make-webpack-config.js	housekeeping: remove extraneous `getbase` aliases (#4671)	6 anni fa
nginx.conf	Change nginx configuration based on BASE_URL, instead of moving actual files	6 anni fa
package-lock.json	Bug/update dependencies (#4543)	6 anni fa
package.json	Bug/update dependencies (#4543)	6 anni fa
postcss.config.js	Fixes #3334 - Add autoprefixer back to postcss plugins	7 anni fa
snapcraft.yaml	Add the daemon	7 anni fa
swagger-config.yaml	use HTTPS for Petstore by default (#4652)	6 anni fa
webpack-dist-bundle.config.js	build(umd-module): prevent mangling (#4320)	6 anni fa
webpack-dist-standalone.config.js	build(umd-module): prevent mangling (#4320)	6 anni fa
webpack-dist.config.js	Revert "initial perf, which gets stripped out in production (#4131)" (#4636)	6 anni fa
webpack-hot-dev-server.config.js	Revert "initial perf, which gets stripped out in production (#4131)" (#4636)	6 anni fa
webpack-watch.config.js	Revert "initial perf, which gets stripped out in production (#4131)" (#4636)	6 anni fa
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 anni fa
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 anni fa
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 anni fa

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.17.1	2018-06-16	2.0, 3.0	tag v3.17.1
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.