前端 Express 框架 Swagger：如何定义多个 API 接口

使用 Swagger 在前端 Express 框架中定义多个 API 接口时，可以将不同路径的 API 接口放置在不同的文件中，例如 user.js 和 product.js。每个文件包含一个独特的路径，以便 Swagger 区分它们。

示例：

const express = require('express');
const app = express();

// 加载 user.js 文件
const user = require('./user');
app.use('/user', user);

// 加载 product.js 文件
const product = require('./product');
app.use('/product', product);

user.js 文件：

/**
 * @swagger
 * /user:
 *   get:
 *     description: 获取所有用户
 *     responses:
 *       200:
 *         description: 成功
 */
router.get('/', function(req, res, next) {
  // ...
});

/**
 * @swagger
 * /user/{id}:
 *   get:
 *     description: 根据 ID 获取用户信息
 *     parameters:
 *       - name: id
 *         description: 用户 ID
 *         in: path
 *         required: true
 *         type: string
 *     responses:
 *       200:
 *         description: 成功
 */
router.get('/:id', function(req, res, next) {
  // ...
});

product.js 文件：

/**
 * @swagger
 * /product:
 *   get:
 *     description: 获取所有产品
 *     responses:
 *       200:
 *         description: 成功
 */
router.get('/', function(req, res, next) {
  // ...
});

/**
 * @swagger
 * /product/{id}:
 *   get:
 *     description: 根据 ID 获取产品信息
 *     parameters:
 *       - name: id
 *         description: 产品 ID
 *         in: path
 *         required: true
 *         type: string
 *     responses:
 *       200:
 *         description: 成功
 */
router.get('/:id', function(req, res, next) {
  // ...
});

使用 Swagger 注释定义 API 描述、参数和响应：

@swagger：用于标记 Swagger 注释的开始。
path：API 的路径，例如 /user 或 /product。
get、post、put、delete：API 的 HTTP 方法。
description：API 的描述。
parameters：API 的参数。
responses：API 的响应。

自动生成 Swagger 文档：

Swagger 可以自动解析 API 文件并生成 API 文档。当 API 文件发生变化时，Swagger 会自动更新文档。