0

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

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

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

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

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

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

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

非常感谢您对此的回应。

谢谢， 拉希特

4

1 回答 1

0

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

在 AsyncAPI 中可以在多个文件中拆分模式对象的定义，这与在OpenAPI中的方式完全相同

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

到目前为止，还没有代码优先的工具可以从 JS 源代码生成 AsyncAPI

于 2020-10-12T19:53:30.897 回答