Skip to content

Upgrading Swashbuckle.AspNetCore 5 to 6

Breaking5.6.3 → 6.9.0Breaking3New24Changed20Fixed43Other37

BreakingUpgrade verdict

3 breaking changes.

  • Swashbuckle no longer reads X-Forwarded-* headers itself; you must configure Microsoft's Forwarded Headers Middleware instead.
  • The old enum string settings are gone; code that sets them will no longer compile.
  • Swashbuckle no longer processes X-Forwarded-* headers; configure Microsoft's Forwarded Headers Middleware to handle them.
3 items need code or config changes

Moves microsoft.extensions.apidescription.server 3.0.0 → 6.0.5. Your build may pick other versions.

3 packages of its own release move with it.

Breaking3
Removes fragile X-Forwarded-* header logic in favor of Microsoft's Forwarded Headers Middleware.
Fully removes the obsolete DescribeAllEnumsAsStrings and DescribeStringEnumsInCamelCase settings.
DescribeAllEnumsAsStringsDescribeStringEnumsInCamelCase
Stops honoring X-Forwarded-* headers within Swashbuckle code; use Microsoft's Forwarded Headers Middleware instead.