hookehuyr

docs(api-integration): 新增接口联调工作记录文档

- 创建接口联调工作记录文档,记录接口文档更新和页面调试情况
- 记录 10 个接口的状态(4 个已完成、1 个联调中、5 个后端开发中)
- 提供接口联调模板文件,便于快速添加新接口记录
- 包含总体进度、接口明细、问题汇总、进度追踪等模块
- 更新 CHANGELOG.md 记录文档变更

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
......@@ -42,11 +42,82 @@
## 📊 快速统计
- **总变更数**: 54+
- **新增功能**: 25+
- **总变更数**: 57+
- **新增功能**: 26+
- **优化改进**: 28+
- **问题修复**: 13+
- **文档更新**: 8+
- **文档更新**: 11+
---
## [2026-02-03] - 新增接口联调记录(登录及反馈消息模块)
### 文档
- 更新接口联调工作记录文档 (`docs/api-integration-log.md`)
- 新增 6 个接口记录:
- 登录(邮箱账号密码)- 🔄 联调中
- 更新个人资料 - ⏳ 后端开发中
- 意见反馈列表 - ⏳ 后端开发中
- 提交意见反馈 - ⏳ 后端开发中
- 我的消息列表 - ⏳ 后端开发中
- 消息详情 - ⏳ 后端开发中
- 更新总体进度:10个接口(4个已完成,1个联调中,5个后端开发中)
---
**详细信息**
- **影响文件**: docs/api-integration-log.md
- **技术栈**: 文档
- **测试状态**: 部分完成
- **备注**:
- 登录接口前端已实现,待联调
- 其他 5 个接口后端开发中
---
## [2026-02-03] - 记录用户中心模块接口联调
### 文档
- 更新接口联调工作记录文档 (`docs/api-integration-log.md`)
- 记录 4 个已完成的用户中心接口:
- 小程序授权 (`miniProgramAuthAPI`)
- 查询登录状态 (`loginStatusAPI`)
- 获取个人信息 (`getProfileAPI`)
- 退出登录 (`logoutAPI`)
- 更新总体进度统计:4/4 已完成 (100%)
---
**详细信息**
- **影响文件**: docs/api-integration-log.md
- **技术栈**: 文档
- **测试状态**: ✅ 已通过(所有接口均已联调完成)
- **备注**:
- 所有接口调用位置已记录
- 接口实现逻辑已说明
- 无阻塞问题
---
## [2026-02-03] - 新增接口联调工作记录文档
### 文档
- 创建接口联调工作记录文档 (`docs/api-integration-log.md`)
- 记录接口文档更新情况和页面实际调试情况
- 提供接口联调模板 (`docs/api-integration-log-template.md`)
- 包含总体进度、接口明细、问题汇总、进度追踪等模块
---
**详细信息**
- **影响文件**: docs/api-integration-log.md, docs/api-integration-log-template.md
- **技术栈**: 文档
- **测试状态**: N/A
- **备注**:
- 记录接口文档更新(版本、变更内容、变更原因)
- 记录页面调试情况(问题、解决方案、状态)
- 支持按状态、模块、负责人快速索引
- 便于前后端对接会议使用
---
......
#### 接口 X: [接口名称]
**接口信息**
- **接口名称**: `xxx`
- **接口路径**: `/srv/?a=xxx`
- **请求方法**: GET/POST
- **负责页面**: `src/pages/xxx/index.vue`
- **负责人**: XXX
**接口文档更新记录**
| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
|------|------|---------|---------|---------|
| YYYY-MM-DD | vX.X | - | - | [查看](#) |
**页面调试情况**
| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
|------|---------|---------|---------|------|
| YYYY-MM-DD | `pages/xxx/index.vue` | - | - | ⏳ 未开始 |
**接口状态**: ⏳ 未开始
**备注**:
-
# 接口联调工作记录
> 记录接口文档更新情况和页面实际调试情况
## 📊 总体进度
- **总接口数**: 10
- **已完成**: 4 (40%)
- **联调中**: 1 (10%)
- **后端开发中**: 5 (50%)
- **有阻塞**: 0
---
## 📝 接口联调明细
### 用户中心模块
#### 接口 1: 小程序授权
**接口信息**
- **接口名称**: `miniProgramAuthAPI`
- **接口路径**: `/srv/?a=openid`
- **请求方法**: POST
- **负责页面**: `src/utils/openid.js` (全局工具)
- **负责人**: 后端团队
**接口文档更新记录**
| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
|------|------|---------|---------|---------|
| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
**页面调试情况**
| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
|------|---------|---------|---------|------|
| 2026-02-03 | `src/utils/openid.js` | 无 | - | ✅ 已完成 |
**接口状态**: ✅ 已完成
**备注**:
- 调用 `wx.login` 获取 code,后端返回 openid
- 授权成功后自动将 sessionid 写入本地存储
- 如果用户已绑定账号,授权接口会自动登录并返回用户信息
- 实现位置:`src/utils/openid.js:miniProgramAuth()`
---
#### 接口 2: 查询登录状态
**接口信息**
- **接口名称**: `loginStatusAPI`
- **接口路径**: `/srv/?a=user&t=login_status`
- **请求方法**: GET
- **负责页面**: `src/stores/user.js` (全局状态管理)
- **负责人**: 后端团队
**接口文档更新记录**
| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
|------|------|---------|---------|---------|
| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
**页面调试情况**
| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
|------|---------|---------|---------|------|
| 2026-02-03 | `src/stores/user.js` | 无 | - | ✅ 已完成 |
**接口状态**: ✅ 已完成
**备注**:
- 返回 `is_login` (是否登录) 和 `is_openid` (是否已授权) 两个字段
- 小程序启动时调用,用于判断是否需要展示登录页
- 实现位置:`src/stores/user.js:checkLoginStatus()`
---
#### 接口 3: 获取个人信息
**接口信息**
- **接口名称**: `getProfileAPI`
- **接口路径**: `/srv/?a=user&t=get_profile`
- **请求方法**: GET
- **负责页面**: `src/pages/mine/index.vue`
- **负责人**: 后端团队
**接口文档更新记录**
| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
|------|------|---------|---------|---------|
| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
**页面调试情况**
| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
|------|---------|---------|---------|------|
| 2026-02-03 | `src/pages/mine/index.vue` | 无 | - | ✅ 已完成 |
**接口状态**: ✅ 已完成
**备注**:
- 返回用户信息:id、avatar_url、name
- 在"我的"页面加载时调用
- 401 自动跳转登录页(由 request.js 拦截器处理)
- 实现位置:`src/pages/mine/index.vue:fetchUserProfile()`
---
#### 接口 4: 退出登录
**接口信息**
- **接口名称**: `logoutAPI`
- **接口路径**: `/srv/?a=user&t=logout`
- **请求方法**: POST
- **负责页面**: `src/pages/mine/index.vue`
- **负责人**: 后端团队
**接口文档更新记录**
| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
|------|------|---------|---------|---------|
| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
**页面调试情况**
| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
|------|---------|---------|---------|------|
| 2026-02-03 | `src/pages/mine/index.vue` | 无 | - | ✅ 已完成 |
**接口状态**: ✅ 已完成
**备注**:
- 解绑 openid 并清除登录状态
- 调用成功后清除本地状态并跳转到首页
- 实现位置:`src/pages/mine/index.vue:handleLogout()`
---
#### 接口 5: 登录(邮箱账号密码)
**接口信息**
- **接口名称**: `loginAPI`
- **接口路径**: `/srv/?a=user&t=login`
- **请求方法**: POST
- **负责页面**: `src/pages/login/index.vue`
- **负责人**: 后端团队
**接口文档更新记录**
| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
|------|------|---------|---------|---------|
| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
**页面调试情况**
| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
|------|---------|---------|---------|------|
| 2026-02-03 | `src/pages/login/index.vue` | 待联调 | - | 🔄 联调中 |
**接口状态**: 🔄 联调中
**备注**:
- 邮箱账号密码登录
- 参数:uuid(邮箱)、password(密码)
- 登录成功后获取用户信息
- 实现位置:`src/stores/user.js:login()`
---
#### 接口 6: 更新个人资料
**接口信息**
- **接口名称**: `updateProfileAPI`
- **接口路径**: `/srv/?a=user&t=update_profile`
- **请求方法**: POST
- **负责页面**: `src/pages/avatar/index.vue`(待确认)
- **负责人**: 后端团队
**接口文档更新记录**
| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
|------|------|---------|---------|---------|
| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
**页面调试情况**
| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
|------|---------|---------|---------|------|
| 2026-02-03 | - | 后端开发中 | - | ⏳ 后端开发中 |
**接口状态**: ⏳ 后端开发中
**备注**:
- 参数:avatar_url(头像URL)
- 用于用户修改头像
- 后端接口开发中
---
### 意见反馈模块
#### 接口 1: 意见反馈列表
**接口信息**
- **接口名称**: `listAPI`
- **接口路径**: `/srv/?a=feedback&t=list`
- **请求方法**: GET
- **负责页面**: `src/pages/feedback/index.vue`(待确认)
- **负责人**: 后端团队
**接口文档更新记录**
| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
|------|------|---------|---------|---------|
| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
**页面调试情况**
| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
|------|---------|---------|---------|------|
| 2026-02-03 | - | 后端开发中 | - | ⏳ 后端开发中 |
**接口状态**: ⏳ 后端开发中
**备注**:
- 参数:page(页码)、limit(每页数量)
- 返回反馈列表,包含状态、类别、图片、回复等信息
- 后端接口开发中
---
#### 接口 2: 提交意见反馈
**接口信息**
- **接口名称**: `submitFeedbackAPI`
- **接口路径**: `/srv/?a=feedback&t=add`
- **请求方法**: POST
- **负责页面**: `src/pages/feedback/index.vue`
- **负责人**: 后端团队
**接口文档更新记录**
| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
|------|------|---------|---------|---------|
| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
**页面调试情况**
| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
|------|---------|---------|---------|------|
| 2026-02-03 | - | 后端开发中 | - | ⏳ 后端开发中 |
**接口状态**: ⏳ 后端开发中
**备注**:
- 参数:category(反馈类别)、note(反馈内容)、contact(联系方式)、images(图片)
- 类别:1=功能建议, 3=界面设计, 5=车辆新鲜, 7=其他问题
- 后端接口开发中
---
### 消息模块
#### 接口 1: 我的消息列表
**接口信息**
- **接口名称**: `myListAPI`
- **接口路径**: `/srv/?a=website_msg&t=my_list`
- **请求方法**: GET
- **负责页面**: 待确认
- **负责人**: 后端团队
**接口文档更新记录**
| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
|------|------|---------|---------|---------|
| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
**页面调试情况**
| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
|------|---------|---------|---------|------|
| 2026-02-03 | - | 后端开发中 | - | ⏳ 后端开发中 |
**接口状态**: ⏳ 后端开发中
**备注**:
- 参数:page(页码)、limit(每页数量)
- 返回用户消息列表
- 后端接口开发中
---
#### 接口 2: 消息详情
**接口信息**
- **接口名称**: `detailAPI`
- **接口路径**: `/srv/?a=website_msg&t=detail`
- **请求方法**: GET
- **负责页面**: 待确认
- **负责人**: 后端团队
**接口文档更新记录**
| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
|------|------|---------|---------|---------|
| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
**页面调试情况**
| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
|------|---------|---------|---------|------|
| 2026-02-03 | - | 后端开发中 | - | ⏳ 后端开发中 |
**接口状态**: ⏳ 后端开发中
**备注**:
- 参数:i(消息ID)
- 返回消息详情
- 后端接口开发中
---
### 模块模板
复制下方模板添加新接口:
```markdown
#### 接口 X: [接口名称]
**接口信息**
- **接口名称**: `xxx`
- **接口路径**: `/srv/?a=xxx`
- **请求方法**: GET/POST
- **负责页面**: `src/pages/xxx/index.vue`
- **负责人**: XXX
**接口文档更新记录**
| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
|------|------|---------|---------|---------|
| YYYY-MM-DD | vX.X | - | - | [查看](#) |
**页面调试情况**
| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
|------|---------|---------|---------|------|
| YYYY-MM-DD | `pages/xxx/index.vue` | - | - | ⏳ 未开始 |
**接口状态**: ⏳ 未开始
**备注**:
-
```
---
## 🔍 问题汇总
### 高优先级问题 🔴
| 问题描述 | 接口名称 | 负责人 | 预计解决时间 |
|---------|---------|--------|------------|
| - | - | - | - |
### 中优先级问题 🟡
| 问题描述 | 接口名称 | 负责人 | 预计解决时间 |
|---------|---------|--------|------------|
| - | - | - | - |
### 低优先级问题 🟢
| 问题描述 | 接口名称 | 负责人 | 预计解决时间 |
|---------|---------|--------|------------|
| - | - | - | - |
---
## 📈 进度追踪
### 本周进度 (2026-01-27 ~ 2026-02-02)
- **新增接口**: 10
- **完成联调**: 4
- **联调中**: 1
- **后端开发中**: 5
- **发现问题**: 0
- **解决问题**: 0
### 历史进度
| 周 | 完成数 | 新增数 | 问题数 |
|----|--------|--------|--------|
| 2026-01-27 ~ 2026-02-02 | 4 | 10 | 0 |
---
## 📌 快速索引
### 按状态查看
- [✅ 已完成](#用户中心模块) - 4个接口
- [🔄 联调中](#用户中心模块) - 1个接口
- [⏳ 后端开发中](#意见反馈模块) - 2个接口
- [⏳ 后端开发中](#消息模块) - 2个接口
- [⏳ 后端开发中](#用户中心模块) - 1个接口
### 按模块查看
- [用户中心](#用户中心模块) - ✅ 4个已完成, 🔄 1个联调中, ⏳ 1个后端开发中
- [意见反馈](#意见反馈模块) - ⏳ 2个后端开发中
- [消息](#消息模块) - ⏳ 2个后端开发中
- [首页](#首页模块) - ⏳ 未开始
- [产品详情](#产品模块) - ⏳ 未开始
- [知识库](#知识库模块) - ⏳ 未开始
- [家办](#家办模块) - ⏳ 未开始
- [签单](#签单模块) - ⏳ 未开始
### 按负责人查看
- [ ] [张三](#张三负责的接口)
- [ ] [李四](#李四负责的接口)
---
## 📖 使用说明
### 状态标识
-**已完成** - 接口正常工作,测试通过
- 🔄 **联调中** - 正在调试,部分功能可用
-**未开始** - 尚未开始联调
- ⚠️ **有阻塞** - 遇到阻塞问题,无法继续
### 优先级标识
- 🔴 **高优先级** - 影响核心功能,需要立即处理
- 🟡 **中优先级** - 影响次要功能,需要尽快处理
- 🟢 **低优先级** - 优化类问题,可以稍后处理
### 记录时机
- **接口文档更新时**: 记录到"接口文档更新记录"表格
- **页面联调时**: 记录到"页面调试情况"表格
- **发现问题**: 记录到对应接口的调试情况,并同步到"问题汇总"
- **解决问题**: 更新调试情况的状态,并从"问题汇总"中移除或标记为已解决
### 维护建议
1. **定期更新**: 每天结束前更新当天的工作记录
2. **同步会议**: 在前后端对接会议上,根据此文档讨论问题
3. **版本控制**: 重要的接口变更应该提交到 Git,便于追溯
---
**最后更新时间**: 2026-02-03 15:00
**文档版本**: v1.2
**更新内容**:
- 新增 6 个接口记录(1个联调中,5个后端开发中)
- 更新总体进度:10个接口(4个已完成,1个联调中,5个后端开发中)