Claus Ibsen created CAMEL-12623:
-----------------------------------

             Summary: Add tool to generate swagger doc at build time
                 Key: CAMEL-12623
                 URL: https://issues.apache.org/jira/browse/CAMEL-12623
             Project: Camel
          Issue Type: New Feature
          Components: tooling
            Reporter: Claus Ibsen


We do not have at this moment a tool that can generate the swagger doc at build 
time. However I think it would be possible to develop such tool. We have 
existing tooling that parses the Java or XML source code (Camel routes) which 
we use for validating endpoints, or do route-coverage reports etc.
 
[https://github.com/apache/camel/blob/master/tooling/maven/camel-maven-plugin/src/main/docs/camel-maven-plugin.adoc]
 
We could then make that tool parse the rest-dsl and build up that model behind 
the scene and feed that into the swagger-java library for it to spit out the 
generated swagger doc.
 
We could make it as a goal on the existing camel-maven-plugin, or build a new 
maven plugin: camel-maven-swagger or something. Then people could use it during 
build time to generate the swagger doc etc. 
 
We maybe should allow to override/configure things as well from the tooling, so 
you can maybe set/mask hostname or set descriptions or other things that may 
not all be detailed in the rest-dsl.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to