记录骆驼路线 [英] Documenting Camel Routes

问题描述

我的项目中有几个 Camel 上下文，如果可能的话，我想以逆向工程的方式记录路线，因为我们希望保持与上下文相关的文档是最新的.最好的方法是什么?

I have several Camel contexts in my project and i would like to document the routes if possible in a reverse engineering fashion since we want to keep the documentation up to date related to the context. what would be the best approach?

推荐答案

您可以只在实际的 DSL 中添加文档，然后使用一些工具或任何提取该路由和文档的工具.

You can just add documentation in the actual DSL and then have some tooling or whatever that extracts that route and documentation.

在 Spring XML DSL 中，您应该能够向路由中的 EIP 添加元素.此外，您还可以添加一般 XML 注释.

In the Spring XML DSL you ought to be able to add elements to the EIPs in the route. Also you can also add general XML comments as well.

同样如上所述，一些 GUI 工具也是一些人想要使用的.然后通常使用 EIP 图标的路由可视化图表就是文档.

Also as mentioned above some GUI tooling is also what some people want to use. Then often the visual diagram of the routes using the EIP icons is the documentation.

FuseSource 目前正在构建一个名为 FuseSource Rider 的 GUI 工具.它将在本月晚些时候进行公开测试.

FuseSource is current building a GUI tool called FuseSource Rider. It will be in public beta later this month.

在 Apache Camel 有一些 maven 工具用于生成 gui 图表http://camel.apache.org/visualisation.html

At Apache Camel there is some maven tooling for generating gui diagrams http://camel.apache.org/visualisation.html

这篇关于记录骆驼路线的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！