Skip to content

Releases: springdoc/springdoc-openapi

springdoc-openapi v3.0.3 released!

11 Apr 23:51

Choose a tag to compare

Added

  • #3246 โ€“ Add Springdoc OpenAPI MCP (Model Context Protocol) support
  • #3256 โ€“ Auto-set nullable: true for Kotlin nullable types in schema properties
  • #3239 โ€“ Add support for the @Range constraint 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) in SpringDocHateoasConfiguration
  • Forwards all MCP non-transport headers to downstream methods
  • Dynamically resolve the base path from window.location.pathname for 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 โ€“ Direction enum: fixed visibility scope of group order so that setGroupsOrder method 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 โ€“ PropertyResolverUtils retains a JsonNode when reading an ExtensionProperty annotation
  • #3226 โ€“ Propagate JsonView context when resolving Page<T> schema

New Contributors

Full Changelog: v3.0.2...v3.0.3

springdoc-openapi v2.8.17 released!

11 Apr 23:51

Choose a tag to compare

Added

  • Add support for the @Range constraint validation annotation
  • Auto-set nullable: true for 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 $ref nullable 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 @ControllerAdvice are still nondeterministic across OS
  • #3236 โ€“ Preserve YAML group URLs in Swagger UI
  • Fix PropertyResolverUtils to retain a JsonNode when reading an ExtensionProperty annotation
  • Fix handling of default values for LocalDate

New Contributors

Full Changelog: v2.8.16...v2.8.17

springdoc-openapi v3.0.2 released!

28 Feb 14:24

Choose a tag to compare

Added

  • #3229 โ€“ Add support for Spring Framework API Versioning with Functional Endpoints
  • #3208 โ€“ Add springdoc.swagger-ui.document-title property

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 using GroupedOpenApi
  • #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 โ€“ OpenApi field in SpringDocConfigProperties does not comply with camel case naming conventions
  • #3215 โ€“ Type annotation not considered when Kotlin is not present
  • #3199 โ€“ Prevent duplicate _links in allOf child 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!

28 Feb 14:21

Choose a tag to compare

Added

  • #3208 - Add support for springdoc.swagger-ui.document-title property 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 using GroupedOpenApi
  • #3226 โ€“ Propagate @JsonView context when resolving Page<T> schema in PageOpenAPIConverter
  • #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 SpringDocConfigProperties does not comply with camelCase naming conventions
  • #3161 โ€“ Prevent duplicate _links in allOf child schemas extending RepresentationModel
  • Fix type annotation not considered when Kotlin is not present
  • Fix property resolution for parameter default values

What's Changed

New Contributors

Full Changelog: v2.8.15...v2.8.16

springdoc-openapi v3.0.1 released!

01 Jan 15:25

Choose a tag to compare

Added

  • #3122 โ€“ Add log notifications when SpringDocs / Scalar are enabled by default
  • #3123 โ€“ Add support for serving static resources
  • #3151 โ€“ Add @Order to ApplicationReadyEvent listener
  • #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 useReturnTypeSchema is 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 @RequestBody did not take precedence
  • #3146 โ€“ Fix WebJar resource handler mappings for Swagger UI resources
  • #3168 โ€“ Support @Schema annotations 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-docs returning 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

Full Changelog: v3.0.0...v3.0.1

springdoc-openapi v2.8.15 released!

01 Jan 15:34

Choose a tag to compare

Added

  • #3122 โ€“ Add log notifications when SpringDocs / Scalar are enabled by default
  • #3123 โ€“ Add support for serving static resources
  • #3151 โ€“ Add @Order to ApplicationReadyEvent listener
  • #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 useReturnTypeSchema is 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 @RequestBody did not take precedence
  • #3146 โ€“ Fix WebJar resource handler mappings for Swagger UI resources
  • #3168 โ€“ Support @Schema annotations 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

New Contributors

Full Changelog: v2.8.14...v2.8.15

springdoc-openapi v3.0.0 released!

21 Nov 02:20

Choose a tag to compare

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!

02 Nov 20:09

Choose a tag to compare

Pre-release

Added

  • #3095 - Add support for Spring Boot 4.0.0-RC1

Full Changelog: v3.0.0-M1...v3.0.0-RC1

springdoc-openapi v2.8.14 released!

02 Nov 20:10

Choose a tag to compare

What's Changed

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

Full Changelog: v2.8.13...v2.8.14

springdoc-openapi v2.8.13 released!

07 Sep 14:51

Choose a tag to compare

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