AsyncAPI -如何在不同的文件中分发定义

Question

我正在考虑在我的项目中使用AsyncAPI来记录RabbitMQ消息传递系统。

我需要做的不是为应用程序中的所有消息创建一个yaml/json文件，而是希望在每个消息自己的文件中为每个消息创建AsyncAPI定义，这与在Swagger中所做的非常相似。

我在一个node express服务器上使用Swagger 2.0来定义REST API。对于API的定义，我使用Swagger的@swagger装饰器在每个API上编写注释，以获取文档。例如：

/**
* @swagger
* /user/register:
*   post:
*     description: Register a new user
...
...
*/

我在routes.js文件中也有一个通用的定义，我在其中定义了所有可重用的东西。

这些定义位于每个API端点文件的顶部。Swagger，收集分布在各种文件中的所有这些文档，并为应用程序中的所有API创建单个文档。

我想知道在AsyncAPI中是否可以做类似的事情，如果可以，我如何实现它。

将非常感谢您对此的回应。

谢谢，Rachit

Answer 1

我需要做的是，不是为应用程序中的所有消息创建一个yaml/json文件，而是希望在每个消息各自的文件中为每个消息创建AsyncAPI定义，就像它在Swagger中所做的那样。

以与like in OpenAPI完全相同的方式，将模式对象的定义拆分到多个文件中

我在一个node express服务器上使用Swagger2.0来定义REST API。对于API的定义，我用@swagger装饰器为Swagger编写每个API的注释，以获取文档。例如：

到目前为止，还没有从JS源代码生成AsyncAPI的code-first tool