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

kyle 5b7e422d75 housekeeping: remove Q&A section from feature template (#4708 )		há 6 anos
.github	housekeeping: remove Q&A section from feature template (#4708)	há 6 anos
dev-helpers	improvement: prevent loading resources from third party CDN (via #4598)	há 6 anos
dist	v3.17.3 (#4706)	há 6 anos
docs	Doc updates	há 6 anos
src	fix: support multimedia media types for file upload (#4705)	há 6 anos
swagger-ui-dist-package	Maintain backwards compatibility with absolutePath	há 7 anos
test	fix: handle urlencoded array data correctly + don't stringify non-object sample values (#4704)	há 6 anos
.agignore	add .aignore	há 7 anos
.babelrc	housekeeping: remove extraneous `getbase` aliases (#4671)	há 6 anos
.dockerignore	feature(docker-image): allow custom nginx port within container (#4086)	há 6 anos
.editorconfig	Create .editorconfig	há 7 anos
.eslintrc	housekeeping: add extraneous module linting (#4697)	há 6 anos
.gitattributes	Set EOL of docker-run.sh to LF	há 7 anos
.gitignore	Bug/update dependencies (#4543)	há 6 anos
.npmignore	improve(npm-module): include standalone preset in `swagger-ui` (#4101)	há 6 anos
.travis.yml	housekeeping: use bundlesize (#4701)	há 6 anos
CONTRIBUTING.md	docs(contributing): add merging pull requests section (#4076)	há 6 anos
Dockerfile	use HTTPS for Petstore by default (#4652)	há 6 anos
LICENSE	Happy new year 🎉	há 6 anos
README.md	v3.17.3 (#4706)	há 6 anos
composer.json	Update composer.json	há 7 anos
docker-run.sh	use HTTPS for Petstore by default (#4652)	há 6 anos
make-webpack-config.js	v3.17.2 (via #4684)	há 6 anos
nginx.conf	Change nginx configuration based on BASE_URL, instead of moving actual files	há 6 anos
package-lock.json	housekeeping: use bundlesize (#4701)	há 6 anos
package.json	v3.17.3 (#4706)	há 6 anos
postcss.config.js	Fixes #3334 - Add autoprefixer back to postcss plugins	há 7 anos
snapcraft.yaml	Add the daemon	há 7 anos
swagger-config.yaml	use HTTPS for Petstore by default (#4652)	há 6 anos
webpack-dist-bundle.config.js	build(umd-module): prevent mangling (#4320)	há 6 anos
webpack-dist-standalone.config.js	build(umd-module): prevent mangling (#4320)	há 6 anos
webpack-dist.config.js	Revert "initial perf, which gets stripped out in production (#4131)" (#4636)	há 6 anos
webpack-hot-dev-server.config.js	Revert "initial perf, which gets stripped out in production (#4131)" (#4636)	há 6 anos
webpack-watch.config.js	Revert "initial perf, which gets stripped out in production (#4131)" (#4636)	há 6 anos
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.	há 7 anos
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.	há 7 anos
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.	há 7 anos

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