如何解决重用jsdoc的@typedef到swagger-jsdoc
上下文:
-
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 举报,一经查实,本站将立刻删除。