重用jsdoc的@typedef到swagger-jsdoc

编程问答 2022-08-15

问题描述

上下文：

  • node.js
  • 打开Api 3
  • express，swagger-jsdoc

我使用 jsdoc 的@typdef使 Intellisens 与 VSCode 自动完成：

/** @typedef {number} Id */

/**
 * @typedef Data
 * @property {Id} requestId
 */

/** @type {Data} */
const data = { id: 42 };

问题：

我刚刚安装了swagger-jsdoc，并将其设置为express。

现在，我想重新使用上面创建的@typedef Data和@typedef Id进行如下大致描述：

/**
 * @swagger
 * 
 * /cats:
 *      get:
 *          description: Search any cat from all parameters in query
 *          produces:
 *              - application/json
 *          parameters:
 *              - name : requestId
 *                in: query
 *                required: false
 *                type: Id <========================== HERE
 *         responses:
 *              200:
 *                  description: cats
 *                  schema:
 *                      type: Data <================== HERE
 */
 router.get('/cats',catsFilter);

此示例无法正常工作。

您知道一种将jsdoc的@typedef转换为swagger-jsdoc的方法吗？

解决方法

暂无找到可以解决该程序问题的有效方法，小编努力寻找整理中！

如果你已经找到好的解决方法，欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@）

expressjsdocswagger