AsyncAPI-如何在不同文件之间分配定义

时间:2020-08-14 16:01:08

标签: node.js rabbitmq asyncapi

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

我需要做的是,而不是为应用程序中的所有消息创建单个yaml / json文件,而是要在其自己的文件中为每个消息创建AsyncAPI定义,就像在Swagger中所做的一样。

我在节点快递服务器上使用Swagger 2.0以获得REST API定义。对于API的定义,我使用@swagger装饰器为每个API编写注释,以供Swagger使用。例如:

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

我在routes.js文件中也有一个通用定义,其中定义了所有可重复使用的内容。

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

我想知道是否可以在AsyncAPI中完成类似的操作,如果可以,我该如何实现?

非常感谢您对此所做的答复。

谢谢, 拉奇特

1 个答案:

答案 0 :(得分:0)

我需要做的是,而不是为应用程序中的所有消息创建单个yaml / json文件,而是要在其自己的文件中为每个消息创建AsyncAPI定义,就像在Swagger中所做的一样。

possible in AsyncAPI的多个文件中的模式对象的拆分定义完全相同,like in OpenAPI

我在节点快递服务器上使用Swagger 2.0以获得REST API定义。对于API的定义,我使用Swagger的@swagger装饰器为每个API编写注释,以获取文档。例如:

到目前为止,没有code-first tool可以从JS源代码生成AsyncAPI