springdoc-openapi

Library for OpenAPI 3 with spring-boot

APACHE-2.0 License

Stars
3.1K
Committers
116

Bot releases are hidden (Show)

springdoc-openapi - springdoc-openapi v2.5.0 released! Latest Release

Published by bnasslahsen 7 months ago

What's Changed

Added

  • #2318 - Add Info to GroupedOpenAPI properties
  • #2554 - Remove duplicate words from comments
  • #2418 - Improve support for externalizing strings in generated openapi
  • #2535 - Add 'springdoc.trim-kotlin-indent' property to handle Kotlin multiline string indentation

Fixed

  • #2525 - Inherited Methods Not Included in Swagger Documentation with @RouterOperation in Spring Boot WebFlux Application
  • #2526 - SpringDoc bean naming conflict error with GraphQL Spring boot starter
  • #2540 - Fix typo in SpringRepositoryRestResourceProvider.java
  • #2549 - Fix README.md

New Contributors

Full Changelog: https://github.com/springdoc/springdoc-openapi/compare/v2.4.0...v2.5.0

springdoc-openapi - springdoc-openapi v2.4.0 released!

Published by bnasslahsen 7 months ago

What's Changed

Changed

  • Upgrade spring-boot to 3.2.3
  • Upgrade swagger-core to 2.2.20
  • Upgrade swagger-ui to 5.11.8

Fixed

  • #2443 - Respect schema annotations when using spring mvc with kotlin
  • #2492, #2488 - Support dynamic evaluation of description field in the RequestBody
  • #2510 - Option to disable root api-docs path when using groups
  • #2453 - Fix CODE_OF_CONDUCT.md links
  • #2454 - Fix typo in SwaggerWelcomeWebMvc
  • #2507 - Fix typo in Constants
  • #2472 - Update JavadocPropertyCustomizer.java
  • #2495 - Fix broken links in README and CONTRIBUTING
  • #2501 - bug fix when "exported" is set to false in RestResource annotation
  • #2447 - Serialization to openapi of org.springframework.data.domain.Sort is not done correctly
  • #2449 - Extensions in subobjects of OpenAPI no longer work
  • #2461 - Springdoc OpenApi Annotations @ExtensionProperty Not Evaluating Properties from application.yml
  • #2469 - Pom contains invalid organizationUrl
  • #2518 - Duplicate GroupConfigs in SpringDocConfigProperties
  • #2506 - Springdoc breaks (Unexpected value: TRACE) when a spring-cloud-starter-gateway-mvc universal gateway is configured.
  • #2519 - Request parameter parsing error after using @NotBlank from type interface field
  • #2516 - Spring Data REST fails when setting version to openapi_3_1
  • #2509 - ArrayIndexOutOfBoundsException in SwaggerUiConfigParameters
  • #2484 - JavaDoc integration not working with SnakeCaseStrategy property naming
  • #2483 - Controller advice documents ApiResponse on every operation, even if the operation does not annotate the exception to be thrown
  • #2477 - buildApiResponses ignores produced ContentType in case of many @Operation

New Contributors

Full Changelog: https://github.com/springdoc/springdoc-openapi/compare/v2.3.0...v2.4.0

springdoc-openapi - springdoc-openapi v1.8.0 released!

Published by bnasslahsen 7 months ago

Added

  • #2189 - Add support for swagger-ui.url property
  • #2200 - Support schema.requiredMode() on ParameterObject
  • #2309 - Added function to preload by specifying locale
  • #2332 - Group name cannot be null or empty
  • #2281 - Initial Virtual thread support
  • #2311 - Enhance springdoc-ui to support spring.mvc.servlet.path
  • #2340 - Add support OIDC with Spring Authorization Server
  • #2345 - Support Schema added in OpenAPI Specification v3.1
  • #2387 - Support get javadoc description from getter method
  • #2404 - Update condition to register links schema customizer
  • #2359 - Update condition to register links schema customizer
  • #2348 - Enhance resource path processing
  • #2438, #2315 - Support for @JsonProperty with Javadoc Change in springdoc-openapi
  • #2443 - Respect schema annotations when using spring mvc with kotlin
  • #2492, #2488 - Support dynamic evaluation of description field in the RequestBody
  • #2510 - Option to disable root api-docs path when using groups

Changed

  • Upgrade spring-boot to 2.7.14
  • Upgrade swagger-core to 2.2.20
  • Upgrade swagger-ui to 5.11.8

Fixed

  • #2199 - Fix Schema get condition of ArraySchema.
  • #2194 - Fix Swagger UI with provided spec
  • #2213 - Using both generated and configured specs stoped working in 1.6.5
  • #2222 - String Index Out of Bounce Exception Fix when deployed on Azure
  • #2243, #2235 - Fix StringIndexOutOfBoundsException when path is same webjar
  • #2291 - Fix default-flat-param-object doesn't work when using http body
  • #2310 - Change bean name of objectMapperProvider
  • #2207 - swagger-initializer.js is sent endcoded in the JVM's default charset
  • #2271, #2280 - Fix loop when response inherits generic class fixes
  • #2239 - Swagger UI not accessible when FormattingConversionService is a CGLIB proxy
  • #2366 - Fix the failed test due to hardcoded file separators
  • #2370, #2371 - No empty description for polymorphic subtypes
  • #2373 - SchemaProperty.array Schema is ignored in /api-docs or api-docs.yaml
  • #2366 - Refactoring AbstractSwaggerResourceResolver.findWebJarResourcePath
  • #2320 - javadoc for class attribute ignored when in EntityModel.
  • #2347 - Not working if a property of entity contains generic parameters.
  • #2399 - SpringdocRouteBuilder.onError is overriding last route defined.
  • #2426 - StackOverflowError when using @ParameterObject on groovy class.
  • #2453 - Fix CODE_OF_CONDUCT.md links
  • #2454 - Fix typo in SwaggerWelcomeWebMvc
  • #2507 - Fix typo in Constants
  • #2472 - Update JavadocPropertyCustomizer.java
  • #2495 - Fix broken links in README and CONTRIBUTING
  • #2501 - bug fix when "exported" is set to false in RestResource annotation
  • #2447 - Serialization to openapi of org.springframework.data.domain.Sort is not done correctly
  • #2449 - Extensions in subobjects of OpenAPI no longer work
  • #2461 - Springdoc OpenApi Annotations @ExtensionProperty Not Evaluating Properties from application.yml
  • #2469 - Pom contains invalid organizationUrl
  • #2518 - Duplicate GroupConfigs in SpringDocConfigProperties
  • #2506 - Springdoc breaks (Unexpected value: TRACE) when a spring-cloud-starter-gateway-mvc universal gateway is configured.
  • #2519 - Request parameter parsing error after using @NotBlank from type interface field
  • #2516 - Spring Data REST fails when setting version to openapi_3_1
  • #2509 - ArrayIndexOutOfBoundsException in SwaggerUiConfigParameters
  • #2484 - JavaDoc integration not working with SnakeCaseStrategy property naming
  • #2483 - Controller advice documents ApiResponse on every operation, even if the operation does not annotate the exception to be thrown
  • #2477 - buildApiResponses ignores produced ContentType in case of many @Operation
springdoc-openapi - springdoc-openapi v2.3.0 released!

Published by bnasslahsen 11 months ago

What's Changed

  • #2359 - Update condition to register links schema customizer
  • #2348 - Enhance resource path processing
  • #2438, #2315 - Support for @JsonProperty with Javadoc Change in springdoc-openapi
  • Upgrade spring-boot to 3.2.0
  • Upgrade swagger-core to 2.2.19
  • Upgrade swagger-ui to 5.10.3

Fixed

  • #2366 - Fix the failed test due to hardcoded file separators
  • #2370, #2371 - No empty description for polymorphic subtypes
  • #2373 - SchemaProperty.array Schema is ignored in /api-docs or api-docs.yaml
  • #2366 - Refactoring AbstractSwaggerResourceResolver.findWebJarResourcePath
  • #2320 - javadoc for class attribute ignored when in EntityModel.
  • #2347 - Not working if a property of entity contains generic parameters.
  • #2399 - SpringdocRouteBuilder.onError is overriding last route defined.
  • #2426 - StackOverflowError when using @ParameterObject on groovy class.

New Contributors

Full Changelog: https://github.com/springdoc/springdoc-openapi/compare/v2.2.0...v2.3.0

springdoc-openapi - springdoc-openapi v2.2.0 released!

Published by bnasslahsen about 1 year ago

Added

  • #2189 - Add support for swagger-ui.url property
  • #2200 - Support schema.requiredMode() on ParameterObject
  • #2309 - Added function to preload by specifying locale
  • #2332 - Group name cannot be null or empty
  • #2281 - Initial Virtual thread support

Changed

  • Upgrade spring-boot to 3.1.2
  • Upgrade swagger-core to 2.2.15
  • Upgrade swagger-ui to 5.2.0

Fixed

  • #2199 - Fix Schema get condition of ArraySchema.
  • #2194 - Fix Swagger UI with provided spec
  • #2213 - Using both generated and configured specs stoped working in 1.6.5
  • #2222 - String Index Out of Bounce Exception Fix when deployed on Azure
  • #2243, #2235 - Fix StringIndexOutOfBoundsException when path is same webjar
  • #2291 - Fix default-flat-param-object doesn't work when using http body
  • #2310 - Change bean name of objectMapperProvider
  • #2207 - swagger-initializer.js is sent endcoded in the JVM's default charset
  • #2271, #2280 - Fix loop when response inherits generic class fixes
  • #2312 - Spec for @ParameterObject disappears if building native-images
  • #2326 - @QuerydslPredicate(root = X.class) annotation at Controller Method level not getting documented in Spring Boot 3

New Contributors

Full Changelog: https://github.com/springdoc/springdoc-openapi/compare/v2.1.0...v2.2.0

springdoc-openapi - springdoc-openapi v2.1.0 released!

Published by bnasslahsen over 1 year ago

What's Changed

Added

  • #2152 - Detect directions in default sort values
  • #2167 #2166 - Add request parameter for token endpoint
  • #2188 - Support of {*param} path patterns

Changed

  • Upgrade spring-boot to 3.0.5
  • Upgrade swagger-core to 2.2.9
  • Upgrade swagger-ui to 4.18.2
  • #2173 - Remove webjars-locator-core

Fixed

  • #2122 - Super tiny fix typo
  • #2131 - Fixed a bug that javadoc of record class parameters was not recognized.
  • #2140 - Javadoc record class parameters not recognized
  • #2123 #2141 - fix spring authorization server response.
  • #2148 - Fix properties show-oauth2-endpoints and SpringDocConfigProperties#showOauth2Endpoint properties name mismatch
  • #2149 - Request parameters with default values are marked as required.
  • #2155 - openApi.getServers() is null in OpenApiCustomiser when using different locales.
  • #2152 - Redundant(wrong) direction appended to @PageableDefault.
  • #2181 #2183 - Fixed DefaultFlatParamObject to work with annotated parameters.
  • #2170 #2187 - All request parameters marked as required for Java controllers in mixed projects in 2.0.3
  • #2165 - Custom Converters are not excluded if not registered for Http Message Converter.
  • #2185 - Fix behaviour of required flag for schema class fields.
  • #2139 - SpringDocSecurityConfiguration class not sufficiently constrained.
  • #2142 - SpringDocJacksonModuleConfiguration is loaded even though there is no ObjectMapperProvider when springdoc.api-docs.enabled = false.

Full Changelog: https://github.com/springdoc/springdoc-openapi/compare/v2.0.4...v2.1.0

springdoc-openapi - springdoc-openapi v1.7.0 released!

Published by bnasslahsen over 1 year ago

What's Changed

Added

  • #2152 - Detect directions in default sort values
  • #2167 #2166 - Add request parameter for token endpoint
  • #2188 - Support of {*param} path patterns

Changed

  • Upgrade spring-boot to 2.7.10
  • Upgrade swagger-core to 2.2.9
  • Upgrade swagger-ui to 4.18.2
  • Spring Native is now superseded by Spring Boot 3 official
  • #2173 - Remove webjars-locator-core

Fixed

  • #2122 - Super tiny fix typo
  • #2131 - Fixed a bug that javadoc of record class parameters was not recognized.
  • #2140 - Javadoc record class parameters not recognized
  • #2123 #2141 - fix spring authorization server response.
  • #2148 - Fix properties show-oauth2-endpoints and SpringDocConfigProperties#showOauth2Endpoint properties name mismatch
  • #2149 - Request parameters with default values are marked as required.
  • #2155 - openApi.getServers() is null in OpenApiCustomiser when using different locales.
  • #2152 - Redundant(wrong) direction appended to @PageableDefault.
  • #2181 #2183 - Fixed DefaultFlatParamObject to work with annotated parameters.
  • #2170 #2187 - All request parameters marked as required for Java controllers in mixed projects in 2.0.3
  • #2165 - Custom Converters are not excluded if not registered for Http Message Converter.
  • #2185 - Fix behaviour of required flag for schema class fields.

New Contributors

Full Changelog: https://github.com/springdoc/springdoc-openapi/compare/v1.6.15...v1.7.0

springdoc-openapi - springdoc-openapi v2.0.4 released!

Published by bnasslahsen over 1 year ago

What's Changed

Changed

  • Upgrade swagger-ui to 4.18.1

Fixed

  • #2123 - Fix spring authorization server response
  • #2131 - Fixed a bug that javadoc of record class parameters was not recognized.
  • #2114 - Exception during WebFlux tests: NoClassDefFoundError: KotlinModule$Builder

Full Changelog: https://github.com/springdoc/springdoc-openapi/compare/v2.0.3...v2.0.4

springdoc-openapi - springdoc-openapi v1.6.15 released!

Published by bnasslahsen over 1 year ago

What's Changed

Added

  • #2006 - Support for nullable request parameters in Kotlin.
  • #2054 - Add copyright and license information to Jar.
  • #2021 - Required field in Schema annotation ignored in Kotlin.
  • #2094 - Initial support for Spring Authorization Server.

Changed

  • Upgrade spring-boot to 2.7.9
  • Upgrade swagger-core to 2.2.8
  • Upgrade swagger-ui to 4.17.1

Fixed

  • #2010 - findByNameContainingIgnoreCaseAndDateBefore throw NullPointerException.
  • #2031 - Path variables parameters are not assigned correctly to endpoints.
  • #2038 - When extends JpaRepository, using @Parameter over the method results in duplicate of the same parameter.
  • #2046 - Map Fields Disappear with Groovy on Classpath.
  • #2051 - Malformed api-docs JSON when StringHttpMessageConverter is not active
  • #2062 - OperationCustomizer is not working with Spring Data REST.
  • #2098 - When getting ExceptionHandler in the controller, use target class in case of AOP Proxy.
  • #2107 - Ordering of GlobalOpenApiCustomizers different than for OpenApiCustomisers.
  • #2089 - Fixed a bug that a NullPointerException is thrown when the description field of RequestBody is null and there is a javadoc description.
  • #2104 - OpenAPI Extensions no longer work.

New Contributors

Full Changelog: https://github.com/springdoc/springdoc-openapi/compare/v1.6.14...v1.6.15

springdoc-openapi - springdoc-openapi v2.0.3 released!

Published by bnasslahsen over 1 year ago

What's Changed

Added

  • #2006 - Support for nullable request parameters in Kotlin.
  • #2054 - Add copyright and license information to Jar.
  • #2021 - Required field in Schema annotation ignored in Kotlin.
  • #2094 - Initial support for Spring Authorization Server.

Changed

  • Upgrade spring-boot to 3.0.4
  • Upgrade swagger-core to 2.2.8
  • Upgrade swagger-ui to 4.17.1

Fixed

  • #2010 - findByNameContainingIgnoreCaseAndDateBefore throw NullPointerException.
  • #2031 - Path variables parameters are not assigned correctly to endpoints.
  • #2038 - When extends JpaRepository, using @Parameter over the method results in duplicate of the same parameter.
  • #2046 - Map Fields Disappear with Groovy on Classpath.
  • #2051 - Malformed api-docs JSON when StringHttpMessageConverter is not active
  • #2062 - OperationCustomizer is not working with Spring Data REST.
  • #2098 - When getting ExceptionHandler in the controller, use target class in case of AOP Proxy.
  • #2107 - Ordering of GlobalOpenApiCustomizers different than for OpenApiCustomisers.
  • #2089 - Fixed a bug that a NullPointerException is thrown when the description field of RequestBody is null and there is a javadoc description.
  • #2104 - OpenAPI Extensions no longer work.

Full Changelog: https://github.com/springdoc/springdoc-openapi/compare/v2.0.2...v2.0.3

springdoc-openapi - springdoc-openapi v2.0.2 released!

Published by bnasslahsen almost 2 years ago

Fixed

  • #2008 - Error when com.fasterxml.jackson.module.kotlin.KotlinModule is not present in classpath

Full Changelog: https://github.com/springdoc/springdoc-openapi/compare/v2.0.1...v2.0.2

springdoc-openapi - springdoc-openapi v2.0.1 released!

Published by bnasslahsen almost 2 years ago

Added

  • #1965 - Prevents premature initialisation of factory-beans
  • #2003 - Resolve property descriptions for arrays

Fixed

  • #1957 - AdditionalModelsConverter Schema params rewriting
  • #1962 - override-with-generic-response shouldn't shallow copy
  • #1985 - IllegalStateException: Duplicate key when two endpoints at the same URL with same header exist
  • #1992 - Java enumeration and Spring Converter no longer generates enum drop-down
  • #2001 - Enum Collection parameter missing type info in Spring Data Rest search method
  • #1961 - ContinuationObject leaks into schema

New Contributors

Full Changelog: https://github.com/springdoc/springdoc-openapi/compare/v2.0.0...v2.0.1

springdoc-openapi - springdoc-openapi v1.6.14 released!

Published by bnasslahsen almost 2 years ago

Added

  • #1965 - Prevents premature initialisation of factory-beans
  • #2003 - Resolve property descriptions for arrays

Changed

  • Upgrade spring-boot to 2.7.6

Fixed

  • #1957 - AdditionalModelsConverter Schema params rewriting
  • #1962 - override-with-generic-response shouldn't shallow copy
  • #1985 - IllegalStateException: Duplicate key when two endpoints at the same URL with same header exist
  • #1992 - Java enumeration and Spring Converter no longer generates enum drop-down.
  • #2001 - Enum Collection parameter missing type info in Spring Data Rest search method

New Contributors

Full Changelog: https://github.com/springdoc/springdoc-openapi/compare/v1.6.13...v1.6.14

springdoc-openapi - springdoc-openapi v2.0.0 released!

Published by bnasslahsen almost 2 years ago

Added

  • #1284 - Add support for Jakarta EE

What's Changed

  • Upgrade spring-boot to v3.0.0
springdoc-openapi - springdoc-openapi v1.6.13 released!

Published by bnasslahsen almost 2 years ago

Added

  • #1929 - Enables no cache on not cache swagger-initializer.js
  • #1922 - Check existence of superclass before accessing its name
  • #1923 - Javadoc description of the @RequestPart param of multipart/form-data to the parameter description

Changed

  • Upgrade spring-boot to 2.7.5
  • Upgrade swagger-core to 2.2.7
  • Upgrade swagger-ui to 4.15.5
  • #1912 - Upgrade spring-security-oauth2 to 2.5.2.RELEASE

Fixed

  • #1892 - springdoc.model-and-view-allowed enhanced
  • #1901 - When @Get, using @Parameter over the method results in duplicate of the same parameter
  • #1909 - ExceptionHandler in controller is not used by another controller
  • #1904 - springdoc-openapi-webflux-ui 2.0.0-M7 + spring actuator + spring cloud crashes at startup
  • #1911 - Wrong type for springdoc.swagger-ui.oauth.useBasicAuthenticationWithAccessCodeGrant configuration property
  • #1931 - Spring Security form login only offers application/json req body type

New Contributors

Full Changelog: https://github.com/springdoc/springdoc-openapi/compare/v1.6.12...v1.6.13

springdoc-openapi - v2.0.0-RC2

Published by bnasslahsen almost 2 years ago

Added

  • #1929 - Enables no cache on not cache swagger-initializer.js
  • #1922 - Check existence of superclass before accessing its name
  • #1923 - Javadoc description of the @RequestPart param of multipart/form-data to the parameter description

Changed

  • Upgrade spring-boot to 3.0.0-RC2
  • Upgrade swagger-core to 2.2.7
  • Upgrade swagger-ui to 4.15.5
  • #1912 - Upgrade spring-security-oauth2 to 2.5.2.RELEASE

Fixed

  • #1892 - springdoc.model-and-view-allowed enhanced
  • #1909 - ExceptionHandler in controller is not used by another controller
  • #1904 - springdoc-openapi-webflux-ui 2.0.0-M7 + spring actuator + spring cloud crashes at startup
  • #1911 - Wrong type for springdoc.swagger-ui.oauth.useBasicAuthenticationWithAccessCodeGrant configuration property
  • #1931 - Spring Security form login only offers application/json req body type.

Full Changelog: https://github.com/springdoc/springdoc-openapi/compare/v2.0.0-RC1...v2.0.0-RC2

springdoc-openapi - v2.0.0-RC1

Published by bnasslahsen almost 2 years ago

Added

  • #1284 - Additional hints for native support

Changed

  • Upgrade to spring-boot 3.0.0-RC1
  • Upgrade swagger-ui to 4.15.0

Fixed

  • #1901 - When @Get, using @Parameter over the method results in duplicate of the same parameter.
  • #1892 - springdoc.model-and-view-allowed.

Full Changelog: https://github.com/springdoc/springdoc-openapi/compare/v2.0.0-M7...v2.0.0-RC1

springdoc-openapi - v2.0.0-M7

Published by bnasslahsen about 2 years ago

Added

  • #1888 - custom Summary for actuator
  • #1881 - Support @Hidden annotation on REST repositories.
  • #1878 - Sort request methods

Changed

  • Upgrade swagger-core to 2.2.4
  • Upgrade swagger-ui to 4.14.3

Fixed

  • #1829 - Wrong schema generation on endpoint consuming multipart form data combined with JsonView
  • #1842 - A HTTP header in multipart/form-data is handled as form item instead of header
  • #1845 - Wrong "response" description with two controllers having its own ExceptionHandler.
springdoc-openapi - springdoc-openapi v1.6.12 released!

Published by bnasslahsen about 2 years ago

Added

  • #1888 - custom Summary for actuator
  • #1881 - Support @Hidden annotation on REST repositories.
  • #1878 - Sort request methods
  • #1830 - Support Java record
  • #1814 - Allow requestBody creation for GET on openapi resource endpoint

Changed

  • Upgrade swagger-core to 2.2.4
  • Upgrade spring-boot to 2.7.4
  • Upgrade swagger-ui to 4.14.3

Fixed

  • #1829 - Wrong schema generation on endpoint consuming multipart form data combined with JsonView
  • #1842 - A HTTP header in multipart/form-data is handled as form item instead of header
  • #1845 - Wrong "response" description with two controllers having its own ExceptionHandler.
  • #1855 - Fixed a bug that duplicate field were get for record classes.
  • #1820 - Refresh the browser each time, the global header is added in duplicate.
  • #523 - No documented way to handle Mono/Flux without Webflux.
  • #1816 - Parameters with same name but different locations can't render in UI properly

New Contributors

Full Changelog: https://github.com/springdoc/springdoc-openapi/compare/v1.6.11...v1.6.12

springdoc-openapi - v2.0.0-M6

Published by bnasslahsen about 2 years ago

Added

Fixed

  • 1855 -Fixed a bug that duplicate field were get for record classes by @uc4w6c in https://github.com/springdoc/springdoc-openapi/pull/1855
  • #1820 - Refresh the browser each time, the global header is added in duplicate.
  • #523 - No documented way to handle Mono/Flux without Webflux
  • #1816 - Parameters with same name but different locations can't render in UI properly

New Contributors

Full Changelog: https://github.com/springdoc/springdoc-openapi/compare/v2.0.0-M5...v2.0.0-M6