express-openapi-validator 使用教程

1. 项目的目录结构及介绍

express-openapi-validator/
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   ├── production.json
│   ├── routes/
│   │   ├── api.js
│   ├── middleware/
│   │   ├── validator.js
├── package.json
├── README.md

• src/: 项目的源代码目录。
  • index.js: 项目的入口文件。
  • config/: 配置文件目录。
    • default.json: 默认配置文件。
    • production.json: 生产环境配置文件。
  • routes/: API 路由文件目录。
    • api.js: API 路由定义文件。
  • middleware/: 中间件目录。
    • validator.js: OpenAPI 验证中间件。
• package.json: 项目依赖和脚本配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

src/index.js 是项目的入口文件，负责启动 Express 服务器并加载必要的中间件和路由。

const express = require('express');
const { ExpressOpenApiValidator } = require('express-openapi-validator');
const apiRouter = require('./routes/api');

const app = express();
const port = process.env.PORT || 3000;

// 加载 OpenAPI 验证中间件
app.use(new ExpressOpenApiValidator({
  apiSpec: './openapi.yaml',
  validateRequests: true,
  validateResponses: true,
}));

// 加载 API 路由
app.use('/api', apiRouter);

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

3. 项目的配置文件介绍

src/config/ 目录下包含项目的配置文件，用于不同环境的配置管理。

• default.json: 默认配置文件，包含所有环境的通用配置。

{
  "server": {
    "port": 3000
  },
  "database": {
    "host": "localhost",
    "port": 5432,
    "name": "mydb"
  }
}

• production.json: 生产环境配置文件，覆盖默认配置中的某些设置。

{
  "server": {
    "port": 8080
  },
  "database": {
    "host": "prod-db-server",
    "port": 5432,
    "name": "prod-db"
  }
}

通过这些配置文件，可以轻松管理不同环境下的配置，确保项目在不同环境下都能正常运行。