Kyle Shockey f546c0b342 | pirms 6 gadiem | |
---|---|---|
.github | pirms 6 gadiem | |
dev-helpers | pirms 6 gadiem | |
dist | pirms 6 gadiem | |
docs | pirms 6 gadiem | |
src | pirms 6 gadiem | |
swagger-ui-dist-package | pirms 7 gadiem | |
test | pirms 6 gadiem | |
.babelrc | pirms 7 gadiem | |
.editorconfig | pirms 7 gadiem | |
.eslintrc | pirms 7 gadiem | |
.gitattributes | pirms 7 gadiem | |
.gitignore | pirms 6 gadiem | |
.npmignore | pirms 6 gadiem | |
.travis.yml | pirms 6 gadiem | |
CONTRIBUTING.md | pirms 6 gadiem | |
Dockerfile | pirms 6 gadiem | |
LICENSE | pirms 7 gadiem | |
README.md | pirms 6 gadiem | |
composer.json | pirms 7 gadiem | |
docker-run.sh | pirms 6 gadiem | |
make-webpack-config.js | pirms 7 gadiem | |
nginx.conf | pirms 7 gadiem | |
package.json | pirms 6 gadiem | |
postcss.config.js | pirms 7 gadiem | |
snapcraft.yaml | pirms 7 gadiem | |
swagger-config.yaml | pirms 7 gadiem | |
webpack-dist-bundle.config.js | pirms 7 gadiem | |
webpack-dist-standalone.config.js | pirms 7 gadiem | |
webpack-dist.config.js | pirms 7 gadiem | |
webpack-hot-dev-server.config.js | pirms 7 gadiem | |
webpack-watch.config.js | pirms 7 gadiem | |
webpack.check.js | pirms 7 gadiem | |
webpack.config.js | pirms 7 gadiem | |
webpack.dist-style.config.js | pirms 7 gadiem |
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:
For the older version of swagger-ui, refer to the 2.x branch.
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 |
You can pull a pre-built docker image of the swagger-ui directly from Dockerhub:
docker pull swaggerapi/swagger-ui
docker run -p 80:8080 swaggerapi/swagger-ui
Will start nginx with swagger-ui on port 80.
Or you can provide your own swagger.json on your host
docker run -p 80:8080 -e SWAGGER_JSON=/foo/swagger.json -v /bar:/foo swaggerapi/swagger-ui
The base URL of the web application can be changed by specifying the BASE_URL
environment variable:
docker run -p 80:8080 -e BASE_URL=/swagger -e SWAGGER_JSON=/foo/swagger.json -v /bar:/foo swaggerapi/swagger-ui
This will serve Swagger UI at /swagger
instead of /
.
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
.
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!
Swagger UI works in the latest versions of Chrome, Safari, Firefox, Edge and IE11.
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.
collectionFormat
is partial.To include the JS, CSS and image assets directly into a webpage, use the swagger-ui-dist package.
The root directory of this package contains the contents of the dist/ directory of this repo.
As a node module, swagger-ui-dist
also exports the swagger-ui-bundle
and swagger-ui-standalone-preset
objects.
To use swagger-ui’s bundles, you should take a look at the source of swagger-ui html page and customize it. This basically requires you to instantiate a SwaggerUi object as below:
const ui = SwaggerUIBundle({
url: "http://petstore.swagger.io/v2/swagger.json",
dom_id: '#swagger-ui',
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout"
})
If you’d like to use the bundle files via npm, check out the swagger-ui-dist
package.
Topbar plugin enables top bar with input for spec path and explore button or a dropdown if urls
is used. By default the plugin is enabled, and to disable it you need to remove Topbar plugin from presets in src/standalone/index.js
:
let preset = [
// TopbarPlugin,
ConfigsPlugin,
() => {
return {
components: { StandaloneLayout }
}
}
]
Configs plugin allows to fetch external configs instead of passing them to SwaggerUIBundle
. Fetched configs support two formats: JSON or yaml. The plugin is enabled by default.
There are three options of passing config:
config
with URL to a server where the configs are hosted. For ex. http://petstore.swagger.io/?config=http://localhost:3001/config.yamlconfigUrl
with URL to SwaggerUIBundleswagger-config.yaml
Note: after changing, the project must be re-builtThese options can be used altogether, the order of inheritance is following (from the lowest priority to the highest):
swagger-config.yaml
-> config passed to SwaggerUIBundle
-> config fetched from configUrl
passed to SwaggerUIBundle
-> config fetched from URL passed as a query parameter config
Please disclose any security-related issues or vulnerabilities by emailing security@swagger.io, instead of using the public issue tracker.
Copyright 2017 SmartBear Software
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.