Repository navigation
Releases
v11.0.0
Swashbuckle.AspNetCore v11.0.0
Important
This release contains major breaking changes.
Read our v11 migration guide for further information.
With this release, Swashbuckle.AspNetCore adds support for generating OpenAPI 3.2 documents and for ASP.NET Core 11.
Swashbuckle.AspNetCore v11 depends on OpenAPI.NET v3.11 which introduces some breaking changes to the public API surface. More information can be found in their OpenAPI.NET v3 Upgrade Guide.
To reduce the number of breaking behavioural changes in Swashbuckle.AspNetCore v11, generation of OpenAPI 3.1 and 3.2 documents is opt-in.
To generate OpenAPI 3.1 or 3.2 documents, change the OpenAPI version as shown in the code snippet below:
app.UseSwagger(options =>
{
options.OpenApiVersion = OpenApiSpecVersion.OpenApi3_1;
// ...or
options.OpenApiVersion = OpenApiSpecVersion.OpenApi3_2;
});Tip
It is strongly recommended that you upgrade to Swashbuckle.AspNetCore v10.3.1 before upgrading to v11.
What's Changed
- Validate packages in parallel by @martincostello in #4223
- Do not generated response codes for empty XML by @Marynat in #4238
- Fix #2596: resolve query properties inherited from a parent interface by @RaphaelFakhri in #4236
- Skip open generic types when finding subtypes by @mohsinaliwork686-rgb in #4245
- Fix crash on non-public Newtonsoft members with UseAllOfForInheritance by @mohsinaliwork686-rgb in #4244
- Mark IReadOnlySet schemas as uniqueItems by @mohsinaliwork686-rgb in #4246
- Support ASP.NET Core 11 by @martincostello in #3786
- Update README by @martincostello in #4250
- Address review feedback by @martincostello in #4251
New Contributors
- @Marynat made their first contribution in #4238
- @mohsinaliwork686-rgb made their first contribution in #4245
Full Changelog: v10.3.1...v11.0.0
v10.3.1
What's Changed
- Remove Swashbuckle.AspNetCore.ApiTesting.Xunit by @martincostello in #4188
- Migrate to xunit v3 by @martincostello in #4189
- Normalize line endings by @martincostello in #4190
- Update .git-blame-ignore-revs by @martincostello in #4191
- Fix
AmbiguousMatchExceptionfor[FromQuery]by @SENESO in #4209 - Avoid deadlock when a schema filter depends on
ISerializerDataContractResolverby @DevKaurav-14 in #4210 - Fix tests by @martincostello in #4214
Deprecations
Important
Swashbuckle.AspNetCore.ApiTesting.Xunit depended on Xunit v2, which is no longer supported.
The package has been removed and no further versions will be released.
New Contributors
- @SENESO made their first contribution in #4209
- @DevKaurav-14 made their first contribution in #4210
Full Changelog: v10.3.0...v10.3.1
v10.3.0
What's Changed
- Change nullability handling for schemas with
anyOf,allOf,oneOfortype = nullby @ldeluigi in #3976 - Handle leading slash on route prefix during index.html GET by @superstator in #4084
- Move NRT handling to DataContractResolver by @desjoerd in #3998
- Clarify nullable behaviour by @martincostello in #4094
- Fix review issues for caching and encoding by @martincostello in #4093
- Support multiple response types per status code by @DeagleGross in #4100
- Add coverage for
AddServeracross multiple documents by @RaphaelFakhri in #4115 - Fix Swagger sort key fallback for empty endpoint tags metadata by @AleksaMCode in #4125
- Fix parameter matching to consider location when names collide by @nonsoikem in #4126
- Emit form encoding for properties of a complex form parameter by @RaphaelFakhri in #4128
- Keep a property's own summary when comments come from several XML files by @RaphaelFakhri in #4129
- Strip query string from relative document URLs in Swagger UI by @GabeSilvaDev in #4152
- Document that System.Text.Json ignores
[EnumMember]by @RaphaelFakhri in #4127 - Drop the regex route constraint from the default Swagger route by @RaphaelFakhri in #4130
- Serialize custom values in the UI
ConfigObject.AdditionalItemsby @RaphaelFakhri in #4132 - Use Minimal APIs JSON options when MVC is not registered by @RaphaelFakhri in #4116
- Resolve enum contracts against the underlying type under source generation by @RaphaelFakhri in #4131
New Contributors
- @ldeluigi made their first contribution in #3976
- @superstator made their first contribution in #4084
- @desjoerd made their first contribution in #3998
- @RaphaelFakhri made their first contribution in #4115
- @AleksaMCode made their first contribution in #4125
- @nonsoikem made their first contribution in #4126
- @GabeSilvaDev made their first contribution in #4152
- @JulianThoms made their first contribution in #4182
Full Changelog: v10.2.3...v10.3.0
v10.2.3
What's Changed
- Bump swagger-ui-dist to 5.32.7 by @dependabot in #4015
Full Changelog: v10.2.2...v10.2.3
v10.2.2
What's Changed
- Update NuGet packages by @martincostello in #3990
- Set
SOURCE_DATE_EPOCHby @martincostello in #3997 - Fix
InvalidOperationExceptionif no route matches by @martincostello in #3999 - Fix empty parameter example not generated by @dldl-cmd in #3932
- Map
[MinLength]/[MaxLength]on dictionary properties tominProperties/maxPropertiesby @KitKeen in #3922 - Fix conflicting required+nullable schema when only NonNullableReferen… by @KitKeen in #3912
- Fix
ExposeSwaggerDocumentUrlsRoutebehaviour by @martincostello in #4000 - Use
NUGET_API_KEYby @martincostello in #4006
New Contributors
Full Changelog: v10.2.1...v10.2.2
v10.2.1
What's Changed
- Update Microsoft.OpenApi to 2.7.5 to pick up fix for GHSA-v5pm-xwqc-g5wc by @martincostello in #3974
Full Changelog: v10.2.0...v10.2.1
v10.2.0
What's Changed
- Add
MapSwaggerUIandMapReDocto support endpoint routing by @Strepto in #3822 - Bump version to 10.2.0 by @martincostello in #3872
- Bump swagger-ui-dist from 5.32.1 to 5.32.2 by @dependabot in #3883
- Support
HEADrequests by @snebjorn in #3887 - Use
IAsyncSwaggerProviderin CLItofilecommand by @bt-Knodel in #3910 - Pin runner images by @martincostello in #3944
- Disable npm install scripts by @martincostello in #3946
- Bump redoc from 2.5.2 to 2.5.3 by @dependabot in #3967
New Contributors
- @Strepto made their first contribution in #3822
- @snebjorn made their first contribution in #3887
- @bt-Knodel made their first contribution in #3910
Full Changelog: v10.1.7...v10.2.0
v10.1.7
What's Changed
- Support custom data type for DataTypeAttribute by @tayfunyuksel in #3868
New Contributors
- @tayfunyuksel made their first contribution in #3868
Full Changelog: v10.1.6...v10.1.7
v10.1.6
What's Changed
- Fix handling of duplicate enum values for dictionaries by @martincostello in #3839
- Log exception when app fails to start in CLI by @ODukhno in #3853
- Fix missing OpenAPI 3.1 $ref properties by @martincostello in #3859
- Add description for OpenAPI schema references by @martincostello in #3860
New Contributors
Full Changelog: v10.1.5...v10.1.6
v10.1.5
What's Changed
- Bump swagger-ui-dist from 5.31.1 to 5.32.0 in /src/Swashbuckle.AspNetCore.SwaggerUI by @dependabot in #3814
- Migrate to actions/attest by @martincostello in #3815
- Disable secrets-outside-env audit by @martincostello in #3823
- Update zizmor to 1.23.1 by @martincostello in #3825
- Fix null examples by @jgarciadelanoceda in #3803
- Bump dependencies by @martincostello in #3835
Full Changelog: v10.1.4...v10.1.5