[CAMEL-17061] camel-openapi-java - Support springdoc when running on Spring Boot

• Type: New Feature
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 3.13.0
• Component/s: camel-openapi-java, camel-spring-boot-starters
• Estimated Complexity: Unknown
• Assignee: Steve Storck
• Reporter: Claus Ibsen
• Created: 09/Oct/21 15:55
• Updated: 31/Oct/21 08:41
• Resolved: 31/Oct/21 08:41

Description

As a user of Camel and Spring Boot, I need a Spring starter library that provides Springdoc integration so that I can use the Springdoc Swagger UI to interact with the endpoints in my application created via the Camel REST DSL.

More info, as discussed on the user forum:

Yeah that is a good idea. However as springdoc is for spring boot
only, then lets put it only into camel-spring-boot project.

camel-springdoc-starter

I have some prototype code I put into camel-openapi-java that can be
moved into this new springdoc-starter and used as a starting point.
Then you should be able to just add camel-springdoc-starter JAR as
dependency to your project and then it comes with the UI included.

I will put my work into a branch on camel-spring-boot upstream, then
you are welcome to look at that and work on the
camel-springdoc-starter.
Documentation should be included in the
src/main/docs/springdoc-starter.adoc file.
 
Btw you need to set context-path in your SB example, in the restConfiguration

       .contextPath("/camel")

It can also be done in yaml at

+  # rest and servlet must have matching context-path
  rest:
    context-path: /camel
    component: servlet

And then make sure to use the default /camel/* servlet context path so
Camel does not "interfere" with spring boot.

 

 

Issue Links

• relates to: CAMEL-17151 camel-openapi-java - Double slashes in api-doc
• relates to: CAMEL-17063 camel-openapi-java - Generated api-doc must use contextPath rest configuration