bubblev
/
swagger-ui
4
0
Fork 0
Koodi Ongelmat 0 Pull-pyynnöt 0 Julkaisut 0 Wiki Toiminta
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
3833 Commitit
2 Branchit
306 MiB
 
 
 
 
Puu: 55fdeeb810
Branchit Tagit
${ item.name }
Create branch ${ searchTerm }
from '55fdeeb810'
${ noResults }
 ZIP  TAR.GZ
kyle 55fdeeb810
Issue template tweaks (#4520) 		6 vuotta sitten
.github Issue template tweaks (#4520) 6 vuotta sitten
dev-helpers fix: provide svg assets through React app instead of relying on HTML (#4429) 6 vuotta sitten
dist v3.14.2 (#4548) 6 vuotta sitten
docs Updated 'urls' (An array of API definition objects) description. (#4525) 6 vuotta sitten
src fix: always display locally-available `title` property as a model's name (#4542) 6 vuotta sitten
swagger-ui-dist-package Maintain backwards compatibility with absolutePath 7 vuotta sitten
test fix: always display locally-available `title` property as a model's name (#4542) 6 vuotta sitten
.agignore add .aignore 7 vuotta sitten
.babelrc v3.14.1 (#4521) 6 vuotta sitten
.dockerignore feature(docker-image): allow custom nginx port within container (#4086) 6 vuotta sitten
.editorconfig Create .editorconfig 7 vuotta sitten
.eslintrc Add ESLint rule that catches `describe.only`, `it.only` 7 vuotta sitten
.gitattributes Set EOL of docker-run.sh to LF 7 vuotta sitten
.gitignore Prepare revised documentation for merge 6 vuotta sitten
.npmignore improve(npm-module): include standalone preset in `swagger-ui` (#4101) 6 vuotta sitten
.travis.yml remove docker login email param (#4283) 6 vuotta sitten
CONTRIBUTING.md docs(contributing): add merging pull requests section (#4076) 6 vuotta sitten
Dockerfile fix(docker): MAINTAINER deprecated. Use LABEL. (#4370) 6 vuotta sitten
LICENSE Happy new year 🎉 6 vuotta sitten
README.md v3.14.2 (#4548) 6 vuotta sitten
composer.json Update composer.json 7 vuotta sitten
docker-run.sh improve(docker): support multiple API URLs option (#4044) 6 vuotta sitten
make-webpack-config.js v3.14.1 (#4521) 6 vuotta sitten
nginx.conf Change nginx configuration based on BASE_URL, instead of moving actual files 6 vuotta sitten
package.json v3.14.2 (#4548) 6 vuotta sitten
postcss.config.js Fixes #3334 - Add autoprefixer back to postcss plugins 7 vuotta sitten
snapcraft.yaml Add the daemon 7 vuotta sitten
swagger-config.yaml in with the new 7 vuotta sitten
webpack-dist-bundle.config.js Switch to `nosource-source-map` for dist builds 7 vuotta sitten
webpack-dist-standalone.config.js Switch to `nosource-source-map` for dist builds 7 vuotta sitten
webpack-dist.config.js Switch to `nosource-source-map` for dist builds 7 vuotta sitten
webpack-hot-dev-server.config.js feat: `onComplete` config option (#4322) 6 vuotta sitten
webpack-watch.config.js Disable minification in npm run watch 7 vuotta sitten
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 vuotta sitten
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 vuotta sitten
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 vuotta sitten

README.md

Swagger UI

NPM version

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.14.2 2018-05-11 2.0, 3.0 tag v3.14.2
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

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.