Kafka Listener 的 Swagger 文档

Question

我已经使用 Swagger 为 REST API 生成文档，但我正在构建 Kafka 监听器并希望为其生成文档。我们有可能使用 Swagger 或类似的东西吗？

谢谢， 马尼什

Answer 1

我也面临着同样的需求，并决定自己创造一些东西。 我称之为 swagger4kafka，它的工作方式与 swagger 非常相似，但它记录了

@KafkaListener

带注释的方法，而不是

RestController

方法。

其源代码托管在 github 中：swagger4kafka 存储库 在自述文件部分，您可以找到如何使用它。

我不会说它已经准备好投入生产，但我认为它对于内部使用非常有用。

Answer 2

Stav Shamir 实际上创建了一个改进的开源解决方案，称为 Springwolf。

它会自动检测 KafkaListener 注释并为异步世界（即 Kafka）创建符合 AsyncAPI 的文档 - 就像 Swagger 对同步 REST API 所做的那样。