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

kyle 743eb8c9c7 Merge pull request #3754 from swagger-api/ft/docs Expand documentation		vor 6 Jahren
.github	Add security notice to issue template	vor 6 Jahren
dev-helpers	Merge branch 'master' of github.com:swagger-api/swagger-ui into ft/docs	vor 6 Jahren
dist	v3.6.0	vor 6 Jahren
docs	Prepare revised documentation for merge	vor 6 Jahren
src	Fix a core system issue blocking preset-plugin wrapComponents	vor 6 Jahren
swagger-ui-dist-package	Maintain backwards compatibility with absolutePath	vor 7 Jahren
test	Fix a core system issue blocking preset-plugin wrapComponents	vor 6 Jahren
.babelrc	Replace babel-polyfill with runtime transform	vor 7 Jahren
.editorconfig	Create .editorconfig	vor 7 Jahren
.eslintrc	Add ESLint rule that catches `describe.only`, `it.only`	vor 7 Jahren
.gitattributes	Set EOL of docker-run.sh to LF	vor 7 Jahren
.gitignore	Prepare revised documentation for merge	vor 6 Jahren
.npmignore	Include `dist/oauth2-redirect.html` in `swagger-ui` module	vor 6 Jahren
.travis.yml	Update .travis.yml	vor 6 Jahren
CONTRIBUTING.md	Update the pre-req version of node in CONTRIBUTING.md	vor 6 Jahren
Dockerfile	Allow UI base url to be customizable	vor 6 Jahren
LICENSE	in with the new	vor 7 Jahren
README.md	Reshuffle more documentation locations	vor 6 Jahren
composer.json	Update composer.json	vor 7 Jahren
docker-run.sh	Allow UI base url to be customizable	vor 6 Jahren
make-webpack-config.js	Switch to `nosource-source-map` for dist builds	vor 7 Jahren
nginx.conf	added dockerfile instructions	vor 7 Jahren
package.json	v3.6.0	vor 6 Jahren
postcss.config.js	Fixes #3334 - Add autoprefixer back to postcss plugins	vor 7 Jahren
snapcraft.yaml	Add the daemon	vor 7 Jahren
swagger-config.yaml	in with the new	vor 7 Jahren
webpack-dist-bundle.config.js	Switch to `nosource-source-map` for dist builds	vor 7 Jahren
webpack-dist-standalone.config.js	Switch to `nosource-source-map` for dist builds	vor 7 Jahren
webpack-dist.config.js	Switch to `nosource-source-map` for dist builds	vor 7 Jahren
webpack-hot-dev-server.config.js	Stop babelifying dev server twice; use `eval-source-map`	vor 7 Jahren
webpack-watch.config.js	Disable minification in npm run watch	vor 7 Jahren
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.	vor 7 Jahren
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.	vor 7 Jahren
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.	vor 7 Jahren

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.6.0	2017-12-01	2.0, 3.0	tag v3.5=6.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

Setting up

How to run

Prerequisites

Node 6.x
NPM 3.x

If you just want to see your specs, open dist/index.html in your browser directly from your filesystem.

If you’d like to make modifications to the codebase, run the dev server with: npm run dev. A development server will open on 3200.

If you’d like to rebuild the /dist folder with your codebase changes, run npm run build.

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.