Skip to content

Swagger-UI 2.1.0-M2 Released!

Compare
Choose a tag to compare
@fehguy fehguy released this 30 Mar 17:54
· 5780 commits to master since this release

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 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 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 and Issues for the final 2.1.0 release.