更新技术实施方案和PRD文档版本历史

backend/app.js

@@ -4,6 +4,8 @@ const helmet = require('helmet')
 const morgan = require('morgan')
 const rateLimit = require('express-rate-limit')
 const compression = require('compression')
+const swaggerJsdoc = require('swagger-jsdoc')
+const swaggerUi = require('swagger-ui-express')
 require('dotenv').config()
 
 // 数据库连接
@@ -19,6 +21,75 @@ app.use(morgan('combined')) // 日志
 app.use(express.json({ limit: '10mb' }))
 app.use(express.urlencoded({ extended: true, limit: '10mb' }))
 
+// Swagger 配置
+const swaggerOptions = {
+  definition: {
+    openapi: '3.0.0',
+    info: {
+      title: '活牛采购智能数字化系统 API',
+      version: '1.0.0',
+      description: '活牛采购标准化操作流程系统接口文档',
+      contact: {
+        name: 'API支持',
+        email: 'support@niumall.com'
+      }
+    },
+    servers: [
+      {
+        url: 'http://localhost:4330/api',
+        description: '开发环境'
+      },
+      {
+        url: 'https://wapi.yunniushi.cn/api',
+        description: '生产环境'
+      }
+    ],
+    components: {
+      securitySchemes: {
+        BearerAuth: {
+          type: 'http',
+          scheme: 'bearer',
+          bearerFormat: 'JWT'
+        }
+      },
+      schemas: {
+        ApiResponse: {
+          type: 'object',
+          properties: {
+            success: { type: 'boolean', description: '请求是否成功' },
+            message: { type: 'string', description: '提示信息' },
+            data: { type: 'object', description: '响应数据' },
+            timestamp: { type: 'string', format: 'date-time', description: '时间戳' }
+          }
+        },
+        PaginationParams: {
+          type: 'object',
+          properties: {
+            page: { type: 'integer', description: '当前页码' },
+            limit: { type: 'integer', description: '每页数量' },
+            sort: { type: 'string', description: '排序字段' },
+            order: { type: 'string', enum: ['asc', 'desc'], description: '排序方向' }
+          }
+        },
+        PaginatedResponse: {
+          type: 'object',
+          properties: {
+            items: { type: 'array', description: '数据列表' },
+            total: { type: 'integer', description: '总记录数' },
+            page: { type: 'integer', description: '当前页码' },
+            limit: { type: 'integer', description: '每页数量' },
+            totalPages: { type: 'integer', description: '总页数' }
+          }
+        }
+      }
+    }
+  },
+  apis: ['./routes/*.js', './models/*.js'] // API路由文件路径
+};
+
+const swaggerSpec = swaggerJsdoc(swaggerOptions);
+app.use('/api/docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));
+
 // 限流
 const limiter = rateLimit({
   windowMs: 15 * 60 * 1000, // 15 分钟