Uh oh!
There was an error while loading. Please reload this page.
Releases: springdoc/springdoc-openapi
Releases · springdoc/springdoc-openapi
Release list
springdoc-openapi v3,1,0 released!
What's Changed
- Fix request-specific Swagger UI index transformations by @limehee in #3279
- Fix #3282: preserve nest() version predicate across all routes in nest by @seonwooj0810 in #3296
- Upgrade Spring Boot to version 4.1.0
- Upgrade Spring AI to version 2.0.0
- Upgrade swagger-core to version 2.2.52
- Upgrade swagger-ui to version 5.32.11
- #3307 – Act upon SonarQube warnings
- #3306 – Act upon SonarQube warnings
Added
- #3269 – Add mechanism to disable
nullablefor Kotlin properties - Allow request-specific Swagger UI index transformation
Fixed
- #3304 – Kotlin parent class's field is not properly marked as nullable
- #3294 – Duplicated path getting
swagger-config - #3293 – Inconsistent OpenAPI schema naming with
SNAKE_CASE: some Java record fields remain camelCase - #3292 – Make
WebPropertiesandWebMvcPropertiesoptional inSwaggerConfig - #3284 – Upgrade swagger-core from version 2.2.48 to 2.2.49
- #3282 – Preserve version from
nest()predicate across all routes innest - #3281 – Stabilize Spring Data
Pageschema property order - #3274 – Description disappears from the generated json after upgrade to 3.0.3
- #3270 – Validation annotation of
ParameterObjectproperty applied toPathVariablewith the same name, even in unrelated endpoints - #3266 – Upgrade swagger-core from version 2.2.47 to 2.2.48
- #3263 – Null key for a
Mapnot allowed in JSON
Full Changelog: v3.0.3...v3.1.0
springdoc-openapi v2.9.0 released!
What's Changed
- Fix version mismatch in springdoc-openapi-tests: update sub-modules to 2.8.18-SNAPSHOT by @ankushsurani in #3262
- Upgrade swagger-core from version 2.2.47 to 2.2.48 by @Mattias-Sehlstedt in #3266
- Add mechanism to disable nullable for Kotlin properties by @0xabadea in #3269
- Stabilize Spring Data Page schema property order by @dpkass in #3281
- Upgrade swagger-core from version 2.2.48 to 2.2.49 by @Mattias-Sehlstedt in #3284
- Fix vulnerabilities: upgrade spring boot to 3.5.14 and swagger-ui to 5.32.5 by @Axel-1 in #3291
- Make WebProperties and WebMvcProperties optional in SwaggerConfig by @seonwooj0810 in #3292
- chore: act upon SonarQube warnings by @Mattias-Sehlstedt in #3306
- Upgrade Spring Boot to version 3.5.16
- Upgrade swagger-core to version 2.2.52
- Upgrade swagger-ui to version 5.32.11
- Upgrade commons-lang to version 3.20.0
- Act upon SonarQube warnings (#3306, #3307)
Added
- Allow request-specific Swagger UI index transformation
- Add a mechanism to disable
nullablefor Kotlin properties
Fixed
- #3304 – Kotlin parent class's field is not properly marked as nullable
- #3298 – Update Spring Boot to 3.5.16
- #3294 – Duplicated path getting
swagger-config - #3293 – Inconsistent OpenAPI schema naming with
SNAKE_CASE: some Java record fields remain camelCase - #3291 – Fix vulnerabilities: upgrade Spring Boot to 3.5.14 and swagger-ui to 5.32.5
- #3288 – Make
WebPropertiesandWebMvcPropertiesoptional inSwaggerConfig - #3281 – Stabilize Spring Data
Pageschema property order - #3274 – Description disappears from the generated JSON after upgrade to 3.0.3
- #3270 – Validation annotation of
ParameterObjectproperty applied toPathVariablewith the same name, even in unrelated endpoints - #3263 – Null key for a
Mapnot allowed in JSON - #3262 – Fix version mismatch in
springdoc-openapi-testsmodules
New Contributors
- @ankushsurani made their first contribution in #3262
- @0xabadea made their first contribution in #3269
- @dpkass made their first contribution in #3281
- @Axel-1 made their first contribution in #3291
Full Changelog: v2.8.17...v2.9.0
springdoc-openapi v3.0.3 released!
Added
- #3246 – Add Springdoc OpenAPI MCP (Model Context Protocol) support
- #3256 – Auto-set
nullable: truefor Kotlin nullable types in schema properties - #3239 – Add support for the
@Rangeconstraint validation annotation - #3244 – Handle default values for
LocalDate
Changed
- Upgrade Spring Boot to version 4.0.5
- Upgrade swagger-core to version 2.2.47
- Upgrade swagger-ui to version 5.32.2
- #3260 –
@ConditionalOnClass(HateoasProperties.class)inSpringDocHateoasConfiguration - Forwards all MCP non-transport headers to downstream methods
- Dynamically resolve the base path from
window.location.pathnamefor MCP UI
Fixed
- #3258 – Setting API Version Required when using WebFlux breaks the Swagger UI
- #3259 – Annotated Generic properties getting applied to sibling properties
- #3255 –
Directionenum: fixed visibility scope of group order so thatsetGroupsOrdermethod can be used - #3247 – Preserve YAML group URLs in Swagger UI
- #3245 – Upgrade swagger-core from version 2.2.43 to 2.2.45
- #3235 –
PropertyResolverUtilsretains aJsonNodewhen reading anExtensionPropertyannotation - #3226 – Propagate
JsonViewcontext when resolvingPage<T>schema
New Contributors
- @seregamorph made their first contribution in #3260
Full Changelog: v3.0.2...v3.0.3
springdoc-openapi v2.8.17 released!
Added
- Add support for the
@Rangeconstraint validation annotation - Auto-set
nullable: truefor Kotlin nullable types in schema properties
Changed
- Upgrade Spring Boot to version 3.5.13
- Upgrade swagger-core to version 2.2.47
- Upgrade swagger-ui to version 5.32.2
Fixed
- #3259 – Fix an issue with annotated types with generics on parameters
- #3255 – Handle
$refnullable wrapping and OAS 3.1 support - #3245 – Upgrade swagger-core from 2.2.43 to 2.2.45 (fixes schema resolution issues)
- #3241 – Generic error responses from multiple
@ControllerAdviceare still nondeterministic across OS - #3236 – Preserve YAML group URLs in Swagger UI
- Fix
PropertyResolverUtilsto retain aJsonNodewhen reading anExtensionPropertyannotation - Fix handling of default values for
LocalDate
New Contributors
- @soowanx made their first contribution in #3247
- @pcalouche made their first contribution in #3254
- @sisco70 made their first contribution in #3255
- @thejeff77 made their first contribution in #3256
- @mcclellanmj made their first contribution in #3259
Full Changelog: v2.8.16...v2.8.17
springdoc-openapi v3.0.2 released!
Added
- #3229 – Add support for Spring Framework API Versioning with Functional Endpoints
- #3208 – Add
springdoc.swagger-ui.document-titleproperty
Changed
- Upgrade Spring Boot to version 4.0.3
- Upgrade swagger-core to version 2.2.43
- Upgrade swagger-ui to version 5.32.0
- Upgrade Scalar to version 0.5.55
Fixed
- #3232 – Gracefully handle springdoc endpoint paths during API version resolution
- #3230 – Scalar source URLs resolve to
null/<groupName>on second request when usingGroupedOpenApi - #3228 – springdoc-openapi-starter 3.x doesn't depend on
org.springframework.boot:spring-boot-starter - #3220 – Reachability metadata not compatible with GraalVM 25
- #3195 – Application won't compile when OpenApi and spring-boot-data-rest is present
- #3193 –
OpenApifield inSpringDocConfigPropertiesdoes not comply with camel case naming conventions - #3215 – Type annotation not considered when Kotlin is not present
- #3199 – Prevent duplicate
_linksinallOfchild schemas - #3198 – Property resolution for parameter default values
- #3206 – Upgrade swagger-core from version 2.2.41 to 2.2.42
Full Changelog: v3.0.1...v3.0.2
springdoc-openapi v2.8.16 released!
Added
- #3208 - Add support for
springdoc.swagger-ui.document-titleproperty to customize the browser tab title
Changed
- Upgrade Spring Boot to version 3.5.11
- Upgrade swagger-core to version 2.2.43
- Upgrade swagger-ui to version 5.32.0
- Upgrade Scalar to version 0.5.55
Fixed
- #3230 – Scalar source URLs resolve to
null/<groupName>on second request when usingGroupedOpenApi - #3226 – Propagate
@JsonViewcontext when resolvingPage<T>schema inPageOpenAPIConverter - #3205 – springdoc-ui does not work with native compile GraalVM 25
- #3219 – Upgrade swagger-core from 2.2.42 to 2.2.43 (fixes schema resolution issues)
- #3193 – OpenApi field in
SpringDocConfigPropertiesdoes not comply with camelCase naming conventions - #3161 – Prevent duplicate
_linksinallOfchild schemas extendingRepresentationModel - Fix type annotation not considered when Kotlin is not present
- Fix property resolution for parameter default values
What's Changed
- Update CONTRIBUTING.adoc by @gwr0-0 in #3209
- Upgrade swagger-core from version 2.2.41 to 2.2.42 by @Mattias-Sehlstedt in #3206
- Fix Gradle dependencies in README by @minseo6753 in #3190
- Fix: Property resolution for parameter default values by @Mattias-Sehlstedt in #3198
- fix(#3161): Prevent duplicate _links in allOf child schemas by @huisoo in #3199
- feat(swagger-ui): add
springdoc.swagger-ui.document-titleproperty by @ardaaltinors in #3208 - docs: fix typos and correct Gradle artifact IDs by @vidya381 in #3211
- fix: add so that the type annotation is considered again if kotlin is not present by @Mattias-Sehlstedt in #3215
- Improve README by @bwaldvogel in #3217
- Upgrade swagger-core from version 2.2.42 to 2.2.43 by @Mattias-Sehlstedt in #3219
- fix: propagate JsonView context when resolving Page schema by @Akila-1329 in #3226
New Contributors
- @gwr0-0 made their first contribution in #3209
- @minseo6753 made their first contribution in #3190
- @huisoo made their first contribution in #3199
- @ardaaltinors made their first contribution in #3208
- @vidya381 made their first contribution in #3211
- @bwaldvogel made their first contribution in #3217
- @Akila-1329 made their first contribution in #3226
Full Changelog: v2.8.15...v2.8.16
springdoc-openapi v3.0.1 released!
Added
- #3122 – Add log notifications when SpringDocs / Scalar are enabled by default
- #3123 – Add support for serving static resources
- #3151 – Add
@OrdertoApplicationReadyEventlistener - #3158 – Add support for API groups in Scalar
- #3187 – Add Scalar WebMVC and WebFlux support
- #3185 – Disable creation of blank GitHub issues (GitHub settings & workflow)
- #3186 – Decouple Web Server APIs following Spring Boot modularization
- #3131 – Improve warning messages when documentation is explicitly enabled
- #3183 – Remove unused operations consumer from route builder methods
- #3141 – Change handling so
useReturnTypeSchemais evaluated at HTTP status code level instead of method level
Changed
- Upgrade Spring Boot to version 4.0.1
- Upgrade swagger-core to version 2.2.41
- Upgrade swagger-ui to version 5.31.0
- Upgrade Scalar to version 0.4.3
Fixed
- #3133 – Fix regression where content type from Swagger
@RequestBodydid not take precedence - #3146 – Fix WebJar resource handler mappings for Swagger UI resources
- #3168 – Support
@Schemaannotations on Kotlin value classes - #3178 – Fix regression when generating documentation for Kotlin
LinkedHashSet - #3170 – Fix warnings when setting title and description in
application.yml - #3173 – Fix
/v3/api-docsreturning Base64-encoded response with Spring Framework 7.0.2 - #3155 – Fix native image support regression with SpringDoc 3.0 and Spring Boot 4.0
What's Changed
- Fix WebJar resource handler mappings for Swagger UI resources by @jamesmissen in #3146
- Decoupling Web Server APIs after Spring Boot modularization by @nicolasb29 in #3186
New Contributors
- @jamesmissen made their first contribution in #3146
- @nicolasb29 made their first contribution in #3186
Full Changelog: v3.0.0...v3.0.1
springdoc-openapi v2.8.15 released!
Added
- #3122 – Add log notifications when SpringDocs / Scalar are enabled by default
- #3123 – Add support for serving static resources
- #3151 – Add
@OrdertoApplicationReadyEventlistener - #3158 – Add support for API groups in Scalar
- #3187 – Add Scalar WebMVC and WebFlux support
- #3185 – Disable creation of blank GitHub issues (GitHub settings & workflow)
- #3186 – Decouple Web Server APIs following Spring Boot modularization
- #3131 - Improve warning messages when documentation is explicitly enabled
- #3183 - Remove unused operations consumer from route builder methods
- #3141 - Change handling so
useReturnTypeSchemais evaluated at HTTP status code level instead of method level
Changed
- Upgrade Spring Boot to version 3.5.9
- Upgrade swagger-core to version 2.2.41
- Upgrade swagger-ui to version 5.31.0
- Upgrade Scalar to version 0.4.3
Fixed
- #3133 – Fix regression where content type from Swagger
@RequestBodydid not take precedence - #3146 – Fix WebJar resource handler mappings for Swagger UI resources
- #3168 – Support
@Schemaannotations on Kotlin value classes - #3178 – Fix regression when generating documentation for Kotlin
LinkedHashSet - #3170 – Fix warnings when setting title and description in
application.yml - #3187 – Add scalar scalar-webmvc and scalar-webflux support
What's Changed
- feat: static resources by @TiPo4u4eK in #3123
- [Fix] Regression where content type from swagger @RequestBody does not take precedence by @Mattias-Sehlstedt in #3133
- docs(security): allow /v3/api-docs(.yaml) & Swagger UI when Spring Security is enabled (management port) by @RituMalav in #3150
- docs(management-port): add example for /v3/api-docs and Swagger UI (#… by @RituMalav in #3148
- Change so useReturnTypeSchema is considered on an http code level by @Mattias-Sehlstedt in #3141
- feat: add @order to ApplicationReadyEvent listener (#3151) by @WeisSebastian in #3153
- Remove unused operations consumer from route builder methods by @JohnNiang in #3183
- Disable creation of a blank GitHub issue by @Mattias-Sehlstedt in #3185
New Contributors
- @TiPo4u4eK made their first contribution in #3123
- @RituMalav made their first contribution in #3150
- @WeisSebastian made their first contribution in #3153
Full Changelog: v2.8.14...v2.8.15
springdoc-openapi v3.0.0 released!
Added
- #2975 - Spring Framework 7 - Initial API versioning support
- #3123 - Support static resources for webflux
Changed
- Upgrade to Spring Boot 4.0.0!
- Upgrade to Scalar 0.4.3
Fixed
- #3131 - Warning messages when docs are explicitly enabled
- #3121 - NPE in KotlinDeprecatedPropertyCustomizer - resolvedSchema is null
Full Changelog: v3.0.0-RC1...v3.0.0
springdoc-openapi v3.0.0-RC1 released!
springdoc-openapi v3.0.0-RC1 released!Pre-release
Pre-release