node.js - Swagger JSDoc 不从子文件夹加载 API 文件

Question

我正在为 node.js 和 express 框架中的项目集成 swagger doc，

NPM： Swagger JSDoc - ^4.0.0 NPM

以下是文件夹结构：（注意：module-1、module-2 和 module-3 是文件夹！）

 - app 

   - module-1 
      - module-1.controller.js
      - module-1.model.js
      - module-1.route.js
   - module-2 
      - module-2.controller.js
      - module-2.model.js
      - module-2.route.js
   - module-3 
      - module-3.controller.js
      - module-3.model.js
      - module-3.route.js

工作示例：

swaggerJSDoc({
    swaggerDefinition: {
        ...require('../swagger.json')
    },
    apis: [
        './app/module-1/*',
        './app/module-2/*'
        './app/module-3/*'
    ]
})

节点：我不想每次像上面的示例一样创建新模块时都添加模块路径。

我期待的是下面的例子：我想像设置主文件夹/文件路径一样设置一次，它会从提供的主文件夹/文件路径自动加载 API Doc 数据。

我尝试下面的示例，但它不适用于/app/*：

swaggerJSDoc({
    swaggerDefinition: {
        ...require('../swagger.json')
    },
    apis: [
        './app/*'
    ]
})

请指导是否有任何方法可以做到这一点，任何形式的建议将不胜感激，谢谢。

标签： node.jsexpressswaggerswagger-jsdocs

Answer 1

那应该工作

apis: ['./app/**/*.js'],