Skip to content

1.1.0
Compare
Choose a tag to compare
@commonsensesoftware commonsensesoftware released this 12 Jun 23:52
v1.1.0
fd6be16

The wait is over. The official v1.1.0 packages have been released! It has taken a number of months to get all of API Explorer work you asked for, while swatting down bugs and knocking out other little features. Most of the release candidate period involved stabilization and burn-in. Many of you contributed time, blood, and sweat to help test, verify, and reproduce issues. Thank you!

All of the previous release notes apply with the following additional, final changes.

Features

  • Support exploring API version parameters

This feature will ultimately enable full Swashbuckle/Swagger integration without using any custom IOperationFilter implementations. Today, the current Swashbuckle implementations do not leverage all of the API explorer information that they could, which is critical for fully documenting the API version parameter information on your behalf. There are open pull requests for all flavors of Swashbuckle to use all of the available metadata. Once that happens, you'll only need to update your Swashbuckle package references, enable Swagger, and the API version parameters will be fully documented for you. In the meantime, you use the simple SwaggerDefaultValues operation filter to bridge the gap. You can see the end-to-end solution in the examples for your flavor of ASP.NET.

Fixes

  • Regression: ASP.NET Core 1.1 RC Action Selection (#133)

Breaking Changes

  • If you have a custom IApiVersionReader, you now must also implement IApiVersionParameterSource

Beyond that, there are no new breaking changes from the previous beta and release candidate releases; however, for ASP.NET Core, do not forget the new configuration setup requirement:

public void Configure( IApplicationBuilder app, IHostingEnvironment env )
{
    app.UseMvc();
    app.UseApiVersioning();
}
Assets 2
Loading