斯瓦格 - 日记
[注] 这个叉子大多是用来不断更新依赖关系,因为原来的回波已经一段时间没有活动了. 但如果你发现问题,可以自由提交带有破解测试的PR(如果是代码问题)并固定.
这个图书馆读取你的 联合来文文件-附加说明的源代码并生成一个 OpenAPI (Swagger) 规格。 。 。 .
开始
想象有这样的 API 文件:
/**
* @openapi
* /:
* get:
* description: Welcome to swagger-jsdoc!
* responses:
* 200:
* description: Returns a mysterious string.
*/
app.get('/', (req, res) => {
res.send('Hello World!');
});
图书馆将接收 @openapi (或 @swagger),配置如下:
const swaggerJsdoc = require('@deadendjs/swagger-jsdoc');
const options = {
definition: {
openapi: '3.0.0',
info: {
title: 'Hello World',
version: '1.0.0'
}
},
apis: ['./src/routes*.js'] // files containing annotations as above
};
const openapiSpecification = await swaggerJsdoc(options);
结果 openapiSpecification 将是一个 摇摆工具- 符合(并经验证)规格.
系统要求
- 节点.js 20.x或以上
你正在观看 swagger-jsdoc v8,发布于CommonJS模块系统.
安装
npm install @deadendjs/swagger-jsdoc --save
支持的规格
- 打开API 3.x
- 斯瓦格2号
- AsyncAPI 2. 0 (英语)
Swagger 文件的验证
默认 swagger-jsdoc 试着把所有文件都解析到最好的能力 如果您想要使用设置选项旗的验证失败, 可以指定一个错误 failOnErrors 改为 true。例如,如果您想要验证您的 swagger docs 使用单位测试进行验证,则此功能是有用的.
const swaggerJsdoc = require('@deadendjs/swagger-jsdoc');
const options = {
failOnErrors: true, // Whether or not to throw when parsing errors. Defaults to false.
definition: {
openapi: '3.0.0',
info: {
title: 'Hello World',
version: '1.0.0'
}
},
apis: ['./src/routes*.js']
};
const openapiSpecification = await swaggerJsdoc(options);