Upgrading Swashbuckle.AspNetCore.SwaggerUI 9 to 10
Breaking9.0.6 → 10.3.1Breaking4Security1New7Changed19Fixed25Other31
SecurityUpdates Microsoft.OpenApi to 2.7.5 to pick up the fix for GHSA-v5pm-xwqc-g5wc.GHSA-v5pm-xwqc-g5wc ↗
BreakingUpgrade verdict
4 breaking changes and a security fix.
In plain terms
- The testing helper package for xUnit is gone and will not get new versions.
- If you use the WithOpenApi() method with this package, it will no longer work.
- This version changes how the package works in ways that may require code changes.
- The underlying OpenAPI library was upgraded and its API changed, so code using it may need updates.
Must act Top 4 of 5 that need code or config changes
Swashbuckle.AspNetCore.SwaggerUI publishes official migration guides for versions 10, 10. They cover more than the release notes do.
V10 migration guide ↗OpenAPI.NET v2 Upgrade Guide ↗Target frameworks requirement changed in 10.0.0: net8.0, net9.0 → net10.0, net8.0, net9.0.
What you must change
Breaking4
Removes the Swashbuckle.AspNetCore.ApiTesting.Xunit package, which depended on unsupported Xunit v2.
Swashbuckle.AspNetCore.ApiTesting.XunitUse of Swashbuckle.AspNetCore with the ASP.NET Core WithOpenApi() method is no longer supported.
WithOpenApi()v10 contains major breaking changes; consult the v10 migration guide before upgrading.
Depends on OpenAPI.NET v2.3, which introduces many breaking changes to the public API surface.
Security1
Updates Microsoft.OpenApi to 2.7.5 to pick up the fix for GHSA-v5pm-xwqc-g5wc.
Microsoft.OpenApi