[ANNOUNCEMENT] Official Swagger 2.0 tools are here!

1,467 views
Skip to first unread message

Ron

unread,
Jun 10, 2015, 9:18:03 AM6/10/15
to swagger-sw...@googlegroups.com
Greetings Swagger Community,

It is our great pleasure to announce that we've pushed out a whole set of tools with official Swagger 2.0 support!
After a few iterations and with constant community support and contributions, we've made it official.

Even though some have been specifically mentioned several times, it's important to credit @whitlockjc, @mohsen1 and @theganyo from Apigee for their Javascript (+node) contributions, plus @wing238,  @xhh and @geekerzp for their codegen contributions, and to the many others who submitted issues, PRs and kept pushing us to provide a higher quality set of tools.

We even have a fancy new blog post about it!

tl;dr

We've released a new version of swagger-js, swagger-ui, swagger-core, swagger-parser, swagger-codegen and the validator-badge.
These include various enhancements to the previous milestone releases (described in the release notes), but notable features are YAML support as a first-class citizen, support for external refs, composition and so much more.

The swagger-core and swagger-codegen have been repackaged as io.swagger - this affects both imports and artifact groupIds.

The community libraries have moved from swagger-spec to our website, and been rearranged to help you find which libraries support Swagger 2.0.

Last, but absolutely not least, we have a new implementation for Node.js integration! Thanks to a major contribution from Apigee, we now have swagger-node with Swagger 2.0 support!
This project replaces the old swagger-node-express implementation.

As always, we look forward to your feedback and contributions to push these projects even further.

And now, for the individual release notes of each project.



Swagger-js 2.1.1 has been released!

The first formal release of Swagger 2.0 support in the javascript library. This project is used extensively by swagger-ui for communicating with swagger-enabled servers. There are many changes between this release and previous 2.0.x versions.

Swagger-js and other formal swagger projects have had intermediate, milestone releases supporting the swagger 2.0 specification. This version supersedes the previous milestones in accordance with the semver strategy.


Usage notes

Swagger-js introduces a new constructor. Instead of passing all arguments in the constructor of swagger-client, the preferred mechanism for instantiation is as follows:

var client = new SwaggerClient();
client.initialize(url, options);

The existing constructor is still supported.


Major changes

  • There is now a general resolver class which is responsible for finding remote references to other objects and bringing them into a single, canonical swagger instance. This step also allows for resolving allOf and other modeling features.
  • You can now pass in a javascript object representing a swagger description. This means remote calls are not necessary when initializing the client to read the spec (#408).
  • Swagger HTTP is now pluggable. That means you can create your own transports to replace the existing superagent or jquery based HTTP clients (#239).
  • YAML is now a first-class format in both core and remote, shared references #323

Notable features

  • allOf composition and inheritence support added to top-level /definitions (note, recursive allOf support is not implemented, nor is allOf enabled for inline models) #455, #188
  • Remote references for models, model properties, parameters, operations now supported, #433, #460, #417
  • Response interceptors can now post-process responses from API calls, #126
  • Support for array collection formats #191
  • Support for referenced path parameters, #360
  • Response headers are now exposed in response models #293
  • Better handling of data types, #341, #353, #339, #343
  • Better display of model description, #294
  • Posting empty body with application/json will now send empty object {} #326
  • Better handling of missing parameters, #375

Notable bug fixes

  • No more global swagger-client instance #350
  • basePath issue for v1.x specs fixed #346
  • enabled default callbacks #308
  • enabled macro support for operations, models #307
  • Authorizations now follow the spec, #283
  • Enum enhancements, fixes #391
  • Global consumes, produces now supported #367
  • Use of reserved words no longer cause a failure to build client #405
  • Read-only attriubutes in model are no longer shown as optional #297
  • Better translation of enum from 1.x specs #376
  • Https in basepath supported #398

Limitations

Find any? Please send bug reports and pull-requests to the develop_2.0 branch!



Swagger-UI 2.1.0 Released!

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 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 Operation#execute: 4764d33, c84202c
  • Proper support for array parameters af39ae0
  • 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 e127bf3
  • OAuth settings correctly set e127bf3, #1134
  • Apply authorizations after UI is loaded 44f2005, #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

Swagger-core 1.5.0 Released!

This is the first formal release of swagger-core with 2.0 spec support. Many thanks to the community for furthering the development of swagger.

Please note! We have repackaged the project from com.wordnik to io.swagger. The code API is the same!


Major changes

  • Better generics support - #498, #1096
  • No-annotations support - #978
  • Support for bean validation (JSR303) - #800
  • Improved composition support - #802, #852
  • Support for remote references - #864
  • More samples migrated to 1.5 and moved to a new repository at swagger-samples - #898,
  • Added parsing of @Api/@ApiOperation#protocols() - #953
  • Improved container support - #954, #955, #1032, #976
  • Improved annotation inheritance support - #1072
  • Added support for constructor parameter declarations - #1085
  • Introduced a new annotation-based configuration method

Bug fixes

  • Subresource integration fixes - #394, #942
  • Fixed support for ranges in allowableValues - #892, #957
  • Support for @ApiImplicitParam - #905
  • Request body not being picked up - #943
  • NPE when configuring swagger-core - #951
  • Fixed processing of @Api/@ApiOperation#produces()/consumes() - #952
  • Enum support - #1019, #1004
  • File upload support for Jersey2 - #1015
  • Recursive packages scanning - #1011
  • Examples are now objects - #988
  • Fixed authorization inheritance - #1041
  • Fixed primitive support for responses - #1120

Swagger Parser 1.0.8

Minor bug-fixes and


Swagger-codegen 2.1.2 Released!

This is the first formal release of swagger-codegen with 2.0 spec support. Many thanks to the community for furthering the development of swagger and especially to @wing328 and @xhh (among others) for their generous contributions to the project.

Please note! We have repackaged the project from com.wordnik to io.swagger. The code API is the same!


Usage notes

Swagger-codegen has a fresh new command-line interface, and can be run, stand-alone or as a web-service from open-source tools.


Major changes

With the added support in swagger-parser, swagger-codegen now supports more complete swagger 2.0 specifications as well as YAML file formats.

Added support for c++ in the QT5 framework, as well as Perl, and Swift.


Notable features

  • added C# generator #373, #399, #665
  • Better support for 1.2 specs #606
  • Improved PHP support #614, #622, #103, #635, #628
  • Python support improvement #594, 595
  • Improved Ruby template support #253
  • Auto-generated method naming improvements #639, #274
  • Java client support improvement #305, #690, #445
  • Objc client support improvement #638, #633
  • Switched to native JSON parsing for Android #687

Notable bug fixes

  • enum support for 1.2 specs fixed #621
  • Nested models in java/android generations fixed #290
  • Fix for recursive examples #728

Validator badge 1.0.1 Released!

Major changes

  • YAML loading support
  • Validator will prompt upgrading to 2.0 for older versions
  • Provide friendlier errors on parsing issues

Bug fixes

  • Proper support for the examples field
Reply all
Reply to author
Forward
0 new messages