接口变更前端文档规则
规则
- 每次涉及接口变更(新增接口、修改请求参数、修改响应结构)时,必须输出一份前端修改文档到
docs/ 目录。
- 文档以 Markdown 格式编写,文件名使用小写字母和下划线,如
docs/customer_handover.md。
- 文档内容至少包含:API 说明(路径、方法、请求参数、响应格式)、涉及的前端页面、具体的修改代码示例。
文档模板
# 功能名称
## 涉及页面
- 页面1
- 页面2
## API
| 方法 | 路径 | 说明 |
|------|------|------|
| POST | /xxx/xxx | 说明 |
**请求参数:**
| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| xxx | String | 是 | xxx |
**响应:** `{ "code": 200, "msg": "操作成功" }`
## 前端修改点
### 1. 按钮/弹窗/表格等
\`\`\`html
<el-button>xxx</el-button>
\`\`\`
### 2. data 数据
\`\`\`js
data() {
return {
xxx: '',
}
}
\`\`\`
### 3. 方法
\`\`\`js
handleXxx() {
// ...
}
\`\`\`
## 注意事项
- 注意事项1
- 注意事项2