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

Can Taşdemir c28213d457 fix(docs): correct plugin api typo (#4138 )		6年前
.github	fix(docs): broken link in the issue template (#4094)	6年前
dev-helpers	Add script documentation to development docs	6年前
dist	release: 3.9.1 (#4106)	6年前
docs	fix(docs): correct plugin api typo (#4138)	6年前
src	fix: execution error in IE (#4128)	6年前
swagger-ui-dist-package	Maintain backwards compatibility with absolutePath	7年前
test	fix: streamline management of user-selected `produces` and `consumes` values (#4137)	6年前
.agignore	add .aignore	7年前
.babelrc	v3.8.0	6年前
.dockerignore	feature(docker-image): allow custom nginx port within container (#4086)	6年前
.editorconfig	Create .editorconfig	7年前
.eslintrc	Add ESLint rule that catches `describe.only`, `it.only`	7年前
.gitattributes	Set EOL of docker-run.sh to LF	7年前
.gitignore	Prepare revised documentation for merge	6年前
.npmignore	improve(npm-module): include standalone preset in `swagger-ui` (#4101)	6年前
.travis.yml	Update .travis.yml	6年前
CONTRIBUTING.md	docs(contributing): add merging pull requests section (#4076)	6年前
Dockerfile	feature(docker-image): allow custom nginx port within container (#4086)	6年前
LICENSE	Happy new year 🎉	6年前
README.md	release: 3.9.1 (#4106)	6年前
composer.json	Update composer.json	7年前
docker-run.sh	feature(docker-image): allow custom nginx port within container (#4086)	6年前
make-webpack-config.js	Pass `false` webpack devtool option instead of `null`	6年前
nginx.conf	Change nginx configuration based on BASE_URL, instead of moving actual files	6年前
package.json	release: 3.9.1 (#4106)	6年前
postcss.config.js	Fixes #3334 - Add autoprefixer back to postcss plugins	7年前
snapcraft.yaml	Add the daemon	7年前
swagger-config.yaml	in with the new	7年前
webpack-dist-bundle.config.js	Switch to `nosource-source-map` for dist builds	7年前
webpack-dist-standalone.config.js	Switch to `nosource-source-map` for dist builds	7年前
webpack-dist.config.js	Switch to `nosource-source-map` for dist builds	7年前
webpack-hot-dev-server.config.js	bug(polyfiller): check for `Promise` on global/window object	6年前
webpack-watch.config.js	Disable minification in npm run watch	7年前
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

New!

This is the new version of swagger-ui, 3.x. Want to learn more? Check out our FAQ.

👉🏼 Want to score an easy open-source contribution? Check out our Good first issue label.

As a brand new version, written from the ground up, there are some known issues and unimplemented features. Check out the Known Issues section for more details.

This repository publishes to two different NPM modules:

swagger-ui is a traditional npm module intended for use in JavaScript web application projects 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 web project that can’t resolve npm module dependencies.

For the older version of swagger-ui, refer to the 2.x branch.

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.9.1	2018-01-12	2.0, 3.0	tag v3.9.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.