# integrateAPI

## 规则（Rules）

# 联调API接口 - 规范

## 1. 联调三要素
- **接口文档**：以API设计文档为准，不直接对照代码联调
- **入参传参**：前端调用时传什么参数、怎么传、格式对不对
- **数据转换**：前后端数据格式不一致时，需要转换适配

## 2. 数据转换规范
- 禁止在前端直接修改后端返回的原始数据结构（必须通过转换函数处理）
- 转换函数必须独立封装，不混入业务逻辑

## 3. 异常场景覆盖
- 必须测试空数据场景
- 必须测试错误参数场景
- 必须测试网络超时场景

## 4. 常见数据格式差异
| 场景 | 后端格式 | 前端需要 | 转换方式 |
|-----|---------|---------|---------|
| 时间格式 | ISO 8601 | 显示格式 | 格式化 |
| 枚举值 | 数字 | 文本 | 映射转换 |
| 字段命名 | snake_case | camelCase | 命名转换 |

## 方法（Methods）

# 联调API接口 - 方法

## 流程概览
```
阅读接口文档 → 检查后端实现 → 检查前端调用 → 编写数据转换 → 逐接口验证 → 修复问题
```

## 步骤1：阅读接口文档
提取每个接口的方法、路径、参数、响应格式。

## 步骤2：检查后端实现
确认后端路由路径、请求方法、参数名称、响应字段是否与文档一致。

## 步骤3：检查前端调用
确认前端请求URL、方法、参数名、请求头是否正确。

## 步骤4：编写数据转换协议
当格式不一致时，编写转换函数（字段命名转换、时间格式转换、枚举映射、数据结构重组）。

## 步骤5：逐接口验证
对每个接口验证：请求→响应→数据转换→异常场景。

## 步骤6：修复问题
分类处理后端问题、前端问题、协议问题。

## 技巧（Tips）

# 联调API接口 - 技巧

## 1. 模拟数据占位
后端接口未完成时，先用模拟数据验证前端调用逻辑。

## 2. 批量字段映射
snake_case ↔ camelCase 转换可编写通用转换函数，避免逐字段手动映射。

## 3. 联调报告模板
用表格记录每个接口的联调结果，方便追踪问题状态。

## 4. 先主后次
先联调核心业务流程的接口，再联调辅助功能接口。