Express 框架 Swagger 分文件最佳实践：模块化组织 API 文档

在使用 Express 框架和 Swagger 时，可以将 Swagger API 文档按照模块分割成多个文件，然后在主文件中引用这些模块文件。这样做可以使 Swagger 文档更加清晰和易于维护。

以下是一个示例：

1. 创建一个名为 'swagger.yaml' 的主 Swagger 文档文件，它包含一个基本的 Swagger 文档模板。

2. 创建一个名为 'user.yaml' 的用户模块 Swagger 文件，该文件包含有关用户模块的 API 信息。

3. 在主 Swagger 文档文件中使用 '$ref' 引用用户模块 Swagger 文件：

swagger: '2.0'
info:
  title: My API
  version: 1.0.0
paths:
  /users:
    $ref: './user.yaml'

4. 在应用程序中使用 Swagger UI 来呈现 API 文档，代码如下：

const express = require('express');
const SwaggerUi = require('swagger-ui-express');
const YAML = require('yamljs');
const swaggerDocument = YAML.load('./swagger.yaml');

const app = express();

app.use('/api-docs', SwaggerUi.serve, SwaggerUi.setup(swaggerDocument));

app.listen(3000, () => {
  console.log('Server started on port 3000');
});

在上述代码中，我们使用 yamljs 库将 Swagger 文档加载到内存中，并将 Swagger UI 挂载到 '/api-docs' 路径上，以便在浏览器中查看 API 文档。

总结：将 Swagger API 文档按照模块分割成多个文件，可以使文档更加清晰和易于维护。在主文件中使用 '$ref' 引用模块文件，然后在应用程序中使用 Swagger UI 来呈现 API 文档。