0

Our REST API is documented using OpenAPI V3. Documentation annotations are used in the controllers which generate an OpenAPI specification which is displayed using a Swagger UI page. Recently we switched to developing endpoints by writing the specification first. The OpenAPI V3 specification isn't generated but written by hand and used to generate interfaces for the controllers and to generate the data transfer objects. The generated classes are available in the REST API project through a dependency. However, while the generated classes are annotated with the same documentation annotations as the 'old' controllers they don't show up in the Swagger UI documentation page. Not even when the dependency package is scanned explicitly using the springdoc.packages-to-scan option.

Is the springdoc-openapi-ui dependency not able to recognize and display documentation from annotations that are in classes in a dependency?

springdoc-openapi-ui version 1.6.14 and openapi-generator-maven-plugin version 6.2.1 are used as the project runs Java 11. My understanding is that the latest version of Springdoc, springdoc-openapi-ui version 1.6.14, uses/requires Spring Boot 3 which in turn requires Java 17 or higher.

Pieter
  • 115
  • 1
  • 1
  • 11

0 Answers0