Releases: springdoc/springdoc-openapi
Releases Β· springdoc/springdoc-openapi
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 v2.8.14 released!
What's Changed
- disable "/v3/api-docs", and "/swagger-ui.html" by default and upgrade to Scalar 0.2.1 by @zakaria-shahen in #3090
- Upgrade swagger-core to version 2.2.38 by @Mattias-Sehlstedt in #3105
- fix:compatible with lower version of getOpenApi(). by @SkyeBeFreeman in #3107
- Add logs to notify when SpringDocs/Scalar is enabled because SpringDocs/Scalar is enabled by default (#3090) by @zakaria-shahen in #3122
Added
- #3090 - Add logs to notify when SpringDocs/Scalar is enabled because SpringDocs/Scalar is enabled by default
Changed
- Upgrade swagger-ui to v5.30.1
- Upgrade swagger-core to v2.2.38
- Upgrade spring-boot to v3.5.7
- Upgrade commons-lang3 to v3.18.0
- Upgrade scalar to v0.3.12
Fixed
- #3107 - Fix:compatible with lower version of getOpenApi().
- #3121 - NPE in KotlinDeprecatedPropertyCustomizer - resolvedSchema is null
New Contributors
- @zakaria-shahen made their first contribution in #3090
- @SkyeBeFreeman made their first contribution in #3107
Full Changelog: v2.8.13...v2.8.14
springdoc-openapi v2.8.13 released!
Added
- #3084 - Add Scalar Support
Changed
- Upgrade swagger-ui to v5.28.1
Fixed
- #3076 - With oneOf the response schema contains an extra type: string
Full Changelog: v2.8.12...v2.8.13
springdoc-openapi v2.8.12 released!
Changed
- Upgrade swagger-ui to v5.28.0
Fixed
- #3073 - Duplicate key class Parameter when documenting two GET methods with same path and PathVariable.
- #3071 - @io.swagger.v3.oas.annotations.parameters.RequestBody does not work well with @RequestPart
- #3066 - Parameter is now required after upgrading to springdoc-openapi 2.8.10
Full Changelog: v2.8.11...v2.8.12
springdoc-openapi v3.0.0-M1 released!
Added
- #3062 - Add Spring Boot 4.0.0-M2 support