[CAMEL-12957] camel-cxf - Swagger/OpenAPI feature should not involve the Camel route

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 2.22.2
• Fix Version/s: 3.0.0, 2.25.0
• Component/s: camel-cxfrs
• Estimated Complexity: Unknown
• Assignee: Freeman Yue Fang
• Reporter: Jens Kleine-Herzbruch
• Created: 26/Nov/18 09:43
• Updated: 13/Aug/19 15:11
• Resolved: 13/Aug/19 15:11

Description

Currently, when adding Swagger2Feature or OpenApiFeature to a CXFRS endpoint, the calls to the API descriptions go through the Camel route, ie. one has to implement an additional Camel route in order to make those features work.

Using runAsFilter=false a call to
http://localhost:8080/services/myCamelService/openapi.json
results in a call of the Camel route with an operation "getOpenApi"

http://localhost:8080/services/myCamelServive/api-docs?url=openapi.json
results in call of the Camel route with an operation "getResource"

Using runAsFilter=true the situation improves marginally:
http://localhost:8080/services/myCamelService/openapi.json
still results in a call of the Camel route with an operation "getOpenApi"

http://localhost:8080/services/myCamelServive/api-docs?url=openapi.json
at least now shows the Swagger UI page frame but still fails to load the actual service description since it again calls the Camel route with the "getOpenApi" operation.

Supposedly that means the filter correctly intercepts the getResource call but not the getOpenApi call. It would be great if this worked out of the box. A custom implementation would still be possible by not running as a filter.

Issue Links

• is blocked by: CXF-8064 OpenApiFeature(OpenAPI V3) should be able to work with camel-cxfrs endpoint