Releases: domaindrivendev/Swashbuckle.AspNetCore
v5.0.0-rc3
Release Summary
This release contains a number of significant changes, including a transition to Swagger/OpenAPI v3 and support for ASP.NET Core 3.0, and will require modifications to your application setup if you're upgrading from previous major versions.
While it's awesome to finally support the latest Swagger/OpenAPI version (v3), this does introduce structural changes to the Swagger object model, which you're likely interacting with to configure and/or extend Swashbuckle. Specific details are provided below but at a high level, the built-in SwaggerDocument and contained types have now been replaced with an OpenApiDocument object model that's imported from the Micorosft/OpenAPI.NET library.
To coincide with the ASP.NET Core 3.0 release in Sep 2019, this version of Swashbuckle will be fully compatible with that version of the framework. At this point, the schema generator is still optimized for Newtonsoft serializer behaviors but additional support for the new System.Text.Json API is planned for a future minor version.
Furthermore, this release also includes a wide range of bug fixes and enhancements including an upgrade of the embedded swagger-ui to 3.23.8, an upgrade of the ReDoc UI to 2.0.0-rc.14, improved handling of IFormFile and FileResult parameters and responses, and support for polymorphic models.
Breaking Changes
- New Swagger/OpenAPI Object Model:
Best case, you can simply replace references to the old Swagger objects (Info, Operation, Schema etc.) with corresponding types from the new object model (e.g. OpenApiInfo, OpenApiOperation, OpenApiSchema) available in the Microsoft.OpenApi.Models namespace. However, the old model was based on version 2.0 of the Swagger/OpenApi spec. whereas the new version is based on 3.0. Therefore, depending on the extent to which you're manipulating the generated Swagger, you may need to re-work some of your code. Check out the official Swagger docs to get a better sense of what's changed between v2 and v3 of the spec.
It's also worth noting ... if you have consumers of the generated Swagger JSON that still depend on v2 of the spec, you can configure the Swagger middleware to continue outputting in that format:
app.UseSwagger(c => c.SerializeAsV2 = true);
- Changes to Filter Interfaces
As a result of the object model change, the Apply method for all filter types accepts a type from the new model instead of the old. For example, IOperationFilter.Apply now accepts an OpenApiOperation, IParameterFilter an OpenApiParameter and so on.
Also, the SchemaRegistry property on filter context objects has been replaced with a SchemaGenerator/SchemaRepository pair of properties. This change is the result of an underlying separating of concerns into "schema generation" and "referenced schema storage". Now, if you need to leverage the schema generator within a filter, it should be invoked as follows:
var schema = context.SchemaGenerator.GenerateSchema(typeof(CustomType), context.SchemaRepository);Finally, the SystemType and JsonContract properties on SchemaFiltercontext have been replaced with a new property of name and type ApiModel. Like JsonContract, this abstracts serializer behavior for a given type, but without coupling to the Newtonsoft library directly, making it easier to support other serializers (e.g. System.Text.Json) going forward. If you need access to the underlying type, use ApiModel.Type instead of SystemType.
Issues Addressed
See https://github.com/domaindrivendev/Swashbuckle.AspNetCore/milestone/7?closed=1
v4.0.0
Release Summary
This release makese an explicit jump to ASP.NET Core 2.0 and the netstandard2.0 library contract. As a result, Swashbuckle can simplify it's implementation by leveraging some of the newer ASP.NET Core features. However, it also means applications need to upgrade their ASP.NET Core stack to 2.0 or above before they can use this version or subsequent versions of Swashbuckle.
It also includes a significant refactor to the way in which Swashbuckle middleware and services are configured, adhering more closely to the ASP.NET Core Options Pattern. This allows for the Swashbuckle components to be configured via appSettings.json if desired.
The other notable change with this release is out-of-the-box support for parameters of type IFormFile. That is, the generator will automatically detect these and generate the correct Swagger to describe parameters that are passed in formData. If you have a workaround in place (e.g. using Operation Filters), you should remove it as part of the upgrade.
Breaking Changes
-
Requires ASP.NET Core 2.0 and netstandard2.0 or above:
Applications need to upgrade their ASP.NET Core stack to 2.0 or above before they can use this version or subsequent versions of Swashbuckle. -
Strongly typed options for SwaggerUI and ReDoc middleware:
May need to update middleware configuration (e.g. inStartup.cs) to compile -
Explicit OperationIds now required:
As per the Swagger spec,operationIds MUST be unique and SHOULD follow common programming conventions. In previous versions, Swashbuckle attempted to generate these values but this has proved increasingly problematic. As a result, this behavior has been removed and the action name or (optionally) the route name is used instead. So, API developers are now responsible to ensure the uniqueness of these values. See the readme topic for more details.
Issues Addressed
See https://github.com/domaindrivendev/Swashbuckle.AspNetCore/milestone/6?closed=1
v3.0.0
Release Summary
Includes two significant changes in addition to a handful of bug fixes and minor enhancements. The generator will now honor the BindRequired and Required attributes on ALL parameters (top-level or property-based) and model properties, flagging the corresponding elements as required in the generated Swagger. Also, the Swagger-specific annotations (SwaggerOperation, SwaggerResponse etc.) have been enhanced, but also extracted from the core functionality into a separate package that consumers need to explicitly install and enable.
Breaking Changes
- Updates to annotations: To continue using the swagger-specific annotations, you'll need to explicitly install and enable the new
Swashbuckle.AspNetCore.Annotationspackage as described here. Furthermore, the attributes have moved from theSwaggerGennamespace to theAnnotationsnamespace, and the ordering of some constructor parameters has changed. So, you'll need to update and test your use of these attributes. - Handling of
Required/BindRequiredattributes: Previously, parameters and properties had to be decorated with these attributes AND be nullable to be flagged asrequiredin the generated Swagger. This has changed and now those attributes will be honored on ALL parameters and model properties.
Issues Addressed
See https://github.com/domaindrivendev/Swashbuckle.AspNetCore/milestone/5?closed=1
v2.4.0
Upgrade to swagger-ui v3.12.0 plus big fixes
v2.1.0
v2.0.0
v1.2.0
Minor bug fixes and enhancements
v1.0.0-rc3
(Hopefully) the last RC before a stable release which will follow shortly assuming no major issues.
Addresses:
#171, #249, #255, #266, #267, #274, #305
Breaking Changes:
- the helper for enabling the UI middleware has been renamed from SwaggerUi to SwaggerUI to align better with .NET naming conventions.