将swagger添加到我的nodejs restify项目

npm install restify swagger-jsdoc swagger-ui-express

const swaggerJsDoc = require('swagger-jsdoc');

const options = {
  definition: {
    openapi: '3.0.0',
    info: {
      title: 'My API',
      version: '1.0.0',
    },
  },
  apis: ['./routes/*.js'], // 指定包含API注释的文件路径
};

const specs = swaggerJsDoc(options);

module.exports = specs;

/**
 * @swagger
 * /users:
 *   get:
 *     summary: Retrieve a list of users
 *     description: Retrieve a list of users from the database.
 *     responses:
 *       200:
 *         description: A list of users.
 *         content:
 *           application/json:
 *             schema:
 *               type: array
 *               items:
 *                 $ref: '#/components/schemas/User'
 */
function getUsers(req, res, next) {
  res.send([{ id: 1, name: 'John Doe' }, { id: 2, name: 'Jane Doe' }]);
  next();
}

module.exports = { getUsers };

const restify = require('restify');
const swaggerUi = require('swagger-ui-express');
const specs = require('./swaggerConfig');

const server = restify.createServer();

server.use(restify.plugins.bodyParser());
server.use(restify.plugins.queryParser());

// 添加Swagger UI
server.use('/api-docs', swaggerUi.serve, swaggerUi.setup(specs));

// 添加路由
const routes = require('./routes/users');
server.get('/users', routes.getUsers);

server.listen(8080, () => {
  console.log('%s listening at %s', server.name, server.url);
});