使用swagger和express时不出现API端点文档。

Question

我正在使用Swagger编写我的API文档。我已经成功地在我的快递项目上设置了Swagger，但是除了app.js文件外，只要在其他路由文件上，端点的文档就不显示了。

以下是我的App.js文件

const express = require('express')
const port = process.env.PORT
const userRouter = require('./routers/user')
require('./db/db')

const app = express()
const swaggerJsDoc = require("swagger-jsdoc");
const swaggerUi = require("swagger-ui-express");

// Extended: https://swagger.io/specification/#infoObject
const swaggerOptions = {
    swaggerDefinition: {
        info: {
            title: "MY API TITLE",
            description: "API Documentation",
            contact: {
                name: "Cali"
            },
            servers: ["http://localhost:3000"]
        }
    },
    // ['.routes/*.js']
    apis: ["app.js"]
};

const swaggerDocs = swaggerJsDoc(swaggerOptions);
app.use("/api/doc", swaggerUi.serve, swaggerUi.setup(swaggerDocs, {explorer: true}));

app.use(express.json())
app.use(userRouter)

app.listen(port, () => {
    console.log(`Server running on port ${port}`)
})

以下是我的用户路由文件

const express = require('express')
const User = require('../models/User')
const auth = require('../middleware/auth')

const router = express.Router()

const swaggerJsdoc = require("swagger-jsdoc");
const swaggerUi = require("swagger-ui-express");


router.use('/api-docs', swaggerUi.serve);
router.get('/api-docs', swaggerUi.setup(swaggerJsdoc));


/**
 * @swagger
 * /customers:
 *  get:
 *    description: Use to request all customers
 *    responses:
 *      '200':
 *        description: A successful response..
 */
router.get('/customers', (req, res) => {
    res.status(200).send('Welcome to Customers page');
})

我做错了什么？PS：我是新来的斯瓦格

Answer 1

你找到问题的答案了吗？

我也曾遇到过类似的问题，我意识到在这一行。

// ['.routes/*.js']
    apis: ["app.js"]

你需要指定你所有的绝对路径 js路由文件 是。你也可以使用正则表达式!

我的项目结构是。

-/src
--/app
----/routes
------login.route.js (here is my **login route** with the @swagger notation)
------user.route.js (here is my **user route** with the @swagger notation)

所以我的正则表达式将是

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