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

Grégoire Charvet 黑瓜 71d7c1a5ab Fix deeplinking for topbar plugin (#4181 ) * Fix deeplinking for topbar plugin * Lint & added tests for search parsing/serialization		пре 6 година
.github	improve(pr-template) (#4156)	пре 6 година
dev-helpers	show oauth error callback message when auth fails (#4058)	пре 6 година
dist	v3.11.0 (#4254)	пре 6 година
docs	Fix Summary links	пре 6 година
src	Fix deeplinking for topbar plugin (#4181)	пре 6 година
swagger-ui-dist-package	Maintain backwards compatibility with absolutePath	пре 7 година
test	Fix deeplinking for topbar plugin (#4181)	пре 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	improve(docker): support multiple API URLs option (#4044)	пре 6 година
LICENSE	Happy new year 🎉	пре 6 година
README.md	v3.11.0 (#4254)	пре 6 година
composer.json	Update composer.json	пре 7 година
docker-run.sh	improve(docker): support multiple API URLs option (#4044)	пре 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	v3.11.0 (#4254)	пре 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.11.0	2018-02-09	2.0, 3.0	tag v3.11.0
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.