This is the first formal release of swagger-ui with 2.0 spec support. Many thanks to the community for furthering the development of swagger!
Usage notes
Initialization of swagger-ui should be consistent with previous 2.1.x-M versions.
Major changes
With the updated swagger-js, swagger-ui now supports relative references, yaml, and composition support. Please see the [swagger-js](https://github.com/swagger-api/swagger-js/releases/tag/v2.1.1) release notes. In addition to updates to the features to support swagger spec 2.0, the UI does not need to be globally referenced, which means you can deploy multiple instances in a single page.
Notable features
- Passing options to Operationexecute: https://github.com/swagger-api/swagger-ui/commit/4764d33fe579f7b52413308debe10f6ef9eb9f1a, https://github.com/swagger-api/swagger-ui/commit/c84202c1d78d44789163422fbfe1ce11aec4189b
- Proper support for array parameters https://github.com/swagger-api/swagger-ui/commit/af39ae06037b1b6936594e91f11c9deee382055c
- Add API-Key to onComplete callback 1170
- Correct handling of empty (201) responses 1173
- Improved handling of enum types 391, 1113
- Support for multiple instances 1086
- Display request headers for sent requests 693
- Added tags for 508 compliance 1021
- Show cUrl output for “try it now” functionality 1315
Notable bug fixes
- Protocol detected from `window.location` if not specified https://github.com/swagger-api/swagger-ui/commit/e127bf35774d30558b3e7230e8518afc95bba692
- OAuth settings correctly set https://github.com/swagger-api/swagger-ui/commit/e127bf35774d30558b3e7230e8518afc95bba692, #1134
- Apply authorizations after UI is loaded https://github.com/swagger-api/swagger-ui/commit/44f200542c801d7a5e4c379100855387c0b6aa4b, #1160
- JS Error on file upload with jQuery 1132
- Responses with type text/plain were not correctly displayed 1109
- Fixed handling for boolean types 1191
- Improved handling of empty/missing content-type header in downloaded responses 1122
- HTTP Basic Auth support regression 1171
- Fixed parameter sorting in UI 1280
- Fixed XSS vulnerability 1262
v2.1.0-M2
This is a major overhaul of Swagger-UI internals. Many thanks to mohsen1 (via Apigee) for driving this release which includes both feature work for Swagger spec 2.0 support as well as infrastructure changes to make the project both easier to enhance and maintain. Without this support, the release would not have been possible.
In 2.1.0-M2, we have moved from coffeescript to pure javascript (961, 1027). We have also moved to gulp for building and Swagger-UI is now AMD-compliant. Much of the Swagger-UI work is delegated to the [Swagger-JS](https://github.com/swagger-api/swagger-js) project.
Usage notes
As with swagger-js, there are major internal changes in the handling of 1.x Swagger specifications. Now, all 1.x specifications are converted to 2.0, which means _multiple base paths are no longer supported in Swagger UI._ Please see the [Swagger-JS release notes](https://github.com/swagger-api/swagger-js/releases/tag/v2.1.0-M2) for more details.
Notable enhancements
152, 498, 600 Rich response types supported, including image, audio, and download.
199, 222, 902, 955 support for multiple instances in a single page
618 examples for 2.0 specs now shown in sample area
573 pass documentation location in URL for easier sharing
463 improved model samples with deep hierarchy
362 improved loading speed by > 1000x
359 improved build process, now fully platform independent
781 removed global variables
777 refactored into single library
683 added externalDocs into UI
672 display enum values in models
621, 1078 remote references for operations, responses
1057 markdown rendering of descriptions
Notable bug fixes
524 state parameter passed in oauth2 requests
554 fixed allowable values (enum) in parameters
858, 802 reserved words as tag names are now gracefully handled
696 proper sorting of response codes
994 `/` in tags breaking shebang
Limitations
There are some unimplemented features of the swagger 2.0 specification in this release. Please see the [Milestones](https://github.com/swagger-api/swagger-ui/milestones/v2.1) and [Issues](https://github.com/swagger-api/swagger-ui/issues?q=is%3Aopen+is%3Aissue+milestone%3Av2.1) for the final 2.1.0 release.
v2.1.8-M1
Several minor fixes and a big upgrade to support remote spec definitions! Read more about what's supported in the [Swagger Spec](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md).
New features
- Remote references, provided in swagger-js-2.1.9-M1 621
- Example objects in operations 618
Issues addressed
- Full tag support for operations
- Descriptions not appearing correctly 932
- Models with deep references are truncated 463
v2.1.1-M1
The Swagger team is proud to announce the M1 release of three of our main libraries and tools: swagger-js, swagger-ui and swagger-core. All release provide official initial support for Swagger 2.0’s main features. The missing features will be added in the next milestone releases until the final release is available.
In order to better improve these libraries and tools, we ask that you start using them and provide us with feedback in form of issues on the github repository. The issues are a huge help in finding what’s missing or not working properly (though note some issues are already submitted). We would also appreciate any PRs that improve existing or new tickets.
These releases could not have happened without the intensive support of the Swagger community. Each of the projects had a few PRs that really helped us push these projects forward!
Be aware that the release notes contain the notable changes, but there may some changes that we missed in the list.
Notable Features:
- Available on [npmjs.org](https://www.npmjs.com/package/swagger-ui)
- First official milestone release of Swagger 2.0 support. Backwards compatible with Swagger 1.2.
- Upgrade third library dependencies.
- Updated to swagger-js 2.1.1-M1
- Move to Gulp as the build tool.
- Swagger-UI can now load Swagger 2.0 specs if they are defined inline without loading from a remote server.
- Improved testing framework with selenium
- Improved possible security issues (such as XSS).
- Added support for GFM where applicable for Swagger 2.0 specs.
- Modified the responses section to accommodate Swagger 2.0 changes.
- New OAuth2 Access Code flow support.
- Hovering over properties now shows the validation constraints.
- Please note that 2.1.1-M1 lives in Master
Notable Bug Fixes:
- Issue with IE Compatibility view (859)
- Issue with supportedSubmitMethods() returning null (856)
- Issue with defaultValue not being filled (855)
- Issue with deprecated operations (852)
- Issue with formData parameters (838)
Limitations:
- Please see the milestones page for unimplemented features (https://github.com/swagger-api/swagger-ui/milestones)