camel_您的Apache Camel应用程序现在包括开箱即用的文档

camel

几个月前，我在博客中发布了有关即将发布的2.15版本的信息，该功能包括获取有关在端点上配置的每个属性的详细信息的功能-Apache Camel，请向我解释这些端点选项的含义。

我们沿着这条道路继续前进，今天我们已经将其从端点扩展到涵盖EIP，数据格式和语言。 简而言之，您几乎在Camel应用程序中使用和配置的所有内容现在都具有在运行时立即提供文档的功能。 此外，所有这些都与标签相关联，我们将其用作分类的一种方式。 因此，您可以列出数据库，云，http，rest，消息传递等的所有组件。

由于在骆驼核心中提供了EIP，因此所有它们的选项都已被完整记录，包括有关其默认值的详细信息，是否需要该选项，是否不建议使用该选项以及当然包括类型信息等。仅记录有简短摘要。

由于Camel包含大约175个组件，因此将需要一些时间来包含有关每个组件的文档。 但是我们将在Apache Camel的构建过程中设置一个报告，该报告输出哪些组件缺少文档。

好的，一张图片值得一千个单词，所以让我在使用hawtio的Web控制台中进行一些实际操作。

首先是EIP的示例，例如具有许多选项的汇总EIP。

在我们的Camel应用程序中显示聚合EIP的属性，包括现成的文件

请注意，顶部有以下复选框：

• 显示/隐藏文档(文档始终作为工具提示提供)
• 显示/隐藏默认值(不是在当前屏幕截图中，而是刚刚添加的)
• 显示/隐藏未使用的值

另一个屏幕快照显示了端点的属性：

在我们的Camel应用程序中显示端点的属性，包括现成的文件

该页面类似于EIP页面。 它还将包含相同的复选框以进行过滤。

还要注意那些灰色的徽章，它们代表该端点已与之关联的标签。 如我们所见，这是一个来自核心的端点及其调度。

所有这些信息都可以在运行时和设计时访问。 在运行时，有来自camel-core的Java和JMX API。 并且在设计时，信息包含在新的驼色目录JAR中，该JAR具有用于每个EIP，组件等的json模式文件。 同样，也可以使用Java和JMX API在运行时从camel-core检索这些json模式文件。

因此，换句话说，这允许最终用户和工具都可以访问此信息。

有关更多信息，请阅读我以前的博客，我在此博客文章的顶部引用了该博客。

下一步是什么

作为Apache Camel的构建过程的一部分，我们尚未实现maven插件，该插件会将EIP文档注入到Spring和Blueprint XML DSL的XSD模式中。 到位后，任何IDE工具都应该能够利用它，因此在编辑这些XML文件时，该工具可以为您提供帮助并提供文档等。

翻译自: https://www.javacodegeeks.com/2015/02/your-apache-camel-applications-now-includes-out-of-the-box-documentation.html

camel