hookehuyr

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

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

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
...@@ -42,11 +42,82 @@ ...@@ -42,11 +42,82 @@
42 42
43 ## 📊 快速统计 43 ## 📊 快速统计
44 44
45 -- **总变更数**: 54+ 45 +- **总变更数**: 57+
46 -- **新增功能**: 25+ 46 +- **新增功能**: 26+
47 - **优化改进**: 28+ 47 - **优化改进**: 28+
48 - **问题修复**: 13+ 48 - **问题修复**: 13+
49 -- **文档更新**: 8+ 49 +- **文档更新**: 11+
50 +
51 +---
52 +
53 +## [2026-02-03] - 新增接口联调记录(登录及反馈消息模块)
54 +
55 +### 文档
56 +- 更新接口联调工作记录文档 (`docs/api-integration-log.md`)
57 +- 新增 6 个接口记录:
58 + - 登录(邮箱账号密码)- 🔄 联调中
59 + - 更新个人资料 - ⏳ 后端开发中
60 + - 意见反馈列表 - ⏳ 后端开发中
61 + - 提交意见反馈 - ⏳ 后端开发中
62 + - 我的消息列表 - ⏳ 后端开发中
63 + - 消息详情 - ⏳ 后端开发中
64 +- 更新总体进度:10个接口(4个已完成,1个联调中,5个后端开发中)
65 +
66 +---
67 +
68 +**详细信息**
69 +- **影响文件**: docs/api-integration-log.md
70 +- **技术栈**: 文档
71 +- **测试状态**: 部分完成
72 +- **备注**:
73 + - 登录接口前端已实现,待联调
74 + - 其他 5 个接口后端开发中
75 +
76 +---
77 +
78 +## [2026-02-03] - 记录用户中心模块接口联调
79 +
80 +### 文档
81 +- 更新接口联调工作记录文档 (`docs/api-integration-log.md`)
82 +- 记录 4 个已完成的用户中心接口:
83 + - 小程序授权 (`miniProgramAuthAPI`)
84 + - 查询登录状态 (`loginStatusAPI`)
85 + - 获取个人信息 (`getProfileAPI`)
86 + - 退出登录 (`logoutAPI`)
87 +- 更新总体进度统计:4/4 已完成 (100%)
88 +
89 +---
90 +
91 +**详细信息**
92 +- **影响文件**: docs/api-integration-log.md
93 +- **技术栈**: 文档
94 +- **测试状态**: ✅ 已通过(所有接口均已联调完成)
95 +- **备注**:
96 + - 所有接口调用位置已记录
97 + - 接口实现逻辑已说明
98 + - 无阻塞问题
99 +
100 +---
101 +
102 +## [2026-02-03] - 新增接口联调工作记录文档
103 +
104 +### 文档
105 +- 创建接口联调工作记录文档 (`docs/api-integration-log.md`)
106 +- 记录接口文档更新情况和页面实际调试情况
107 +- 提供接口联调模板 (`docs/api-integration-log-template.md`)
108 +- 包含总体进度、接口明细、问题汇总、进度追踪等模块
109 +
110 +---
111 +
112 +**详细信息**
113 +- **影响文件**: docs/api-integration-log.md, docs/api-integration-log-template.md
114 +- **技术栈**: 文档
115 +- **测试状态**: N/A
116 +- **备注**:
117 + - 记录接口文档更新(版本、变更内容、变更原因)
118 + - 记录页面调试情况(问题、解决方案、状态)
119 + - 支持按状态、模块、负责人快速索引
120 + - 便于前后端对接会议使用
50 121
51 --- 122 ---
52 123
......
1 +#### 接口 X: [接口名称]
2 +
3 +**接口信息**
4 +- **接口名称**: `xxx`
5 +- **接口路径**: `/srv/?a=xxx`
6 +- **请求方法**: GET/POST
7 +- **负责页面**: `src/pages/xxx/index.vue`
8 +- **负责人**: XXX
9 +
10 +**接口文档更新记录**
11 +
12 +| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
13 +|------|------|---------|---------|---------|
14 +| YYYY-MM-DD | vX.X | - | - | [查看](#) |
15 +
16 +**页面调试情况**
17 +
18 +| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
19 +|------|---------|---------|---------|------|
20 +| YYYY-MM-DD | `pages/xxx/index.vue` | - | - | ⏳ 未开始 |
21 +
22 +**接口状态**: ⏳ 未开始
23 +
24 +**备注**:
25 +-
1 +# 接口联调工作记录
2 +
3 +> 记录接口文档更新情况和页面实际调试情况
4 +
5 +## 📊 总体进度
6 +
7 +- **总接口数**: 10
8 +- **已完成**: 4 (40%)
9 +- **联调中**: 1 (10%)
10 +- **后端开发中**: 5 (50%)
11 +- **有阻塞**: 0
12 +
13 +---
14 +
15 +## 📝 接口联调明细
16 +
17 +### 用户中心模块
18 +
19 +#### 接口 1: 小程序授权
20 +
21 +**接口信息**
22 +- **接口名称**: `miniProgramAuthAPI`
23 +- **接口路径**: `/srv/?a=openid`
24 +- **请求方法**: POST
25 +- **负责页面**: `src/utils/openid.js` (全局工具)
26 +- **负责人**: 后端团队
27 +
28 +**接口文档更新记录**
29 +
30 +| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
31 +|------|------|---------|---------|---------|
32 +| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
33 +
34 +**页面调试情况**
35 +
36 +| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
37 +|------|---------|---------|---------|------|
38 +| 2026-02-03 | `src/utils/openid.js` | 无 | - | ✅ 已完成 |
39 +
40 +**接口状态**: ✅ 已完成
41 +
42 +**备注**:
43 +- 调用 `wx.login` 获取 code,后端返回 openid
44 +- 授权成功后自动将 sessionid 写入本地存储
45 +- 如果用户已绑定账号,授权接口会自动登录并返回用户信息
46 +- 实现位置:`src/utils/openid.js:miniProgramAuth()`
47 +
48 +---
49 +
50 +#### 接口 2: 查询登录状态
51 +
52 +**接口信息**
53 +- **接口名称**: `loginStatusAPI`
54 +- **接口路径**: `/srv/?a=user&t=login_status`
55 +- **请求方法**: GET
56 +- **负责页面**: `src/stores/user.js` (全局状态管理)
57 +- **负责人**: 后端团队
58 +
59 +**接口文档更新记录**
60 +
61 +| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
62 +|------|------|---------|---------|---------|
63 +| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
64 +
65 +**页面调试情况**
66 +
67 +| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
68 +|------|---------|---------|---------|------|
69 +| 2026-02-03 | `src/stores/user.js` | 无 | - | ✅ 已完成 |
70 +
71 +**接口状态**: ✅ 已完成
72 +
73 +**备注**:
74 +- 返回 `is_login` (是否登录) 和 `is_openid` (是否已授权) 两个字段
75 +- 小程序启动时调用,用于判断是否需要展示登录页
76 +- 实现位置:`src/stores/user.js:checkLoginStatus()`
77 +
78 +---
79 +
80 +#### 接口 3: 获取个人信息
81 +
82 +**接口信息**
83 +- **接口名称**: `getProfileAPI`
84 +- **接口路径**: `/srv/?a=user&t=get_profile`
85 +- **请求方法**: GET
86 +- **负责页面**: `src/pages/mine/index.vue`
87 +- **负责人**: 后端团队
88 +
89 +**接口文档更新记录**
90 +
91 +| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
92 +|------|------|---------|---------|---------|
93 +| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
94 +
95 +**页面调试情况**
96 +
97 +| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
98 +|------|---------|---------|---------|------|
99 +| 2026-02-03 | `src/pages/mine/index.vue` | 无 | - | ✅ 已完成 |
100 +
101 +**接口状态**: ✅ 已完成
102 +
103 +**备注**:
104 +- 返回用户信息:id、avatar_url、name
105 +- 在"我的"页面加载时调用
106 +- 401 自动跳转登录页(由 request.js 拦截器处理)
107 +- 实现位置:`src/pages/mine/index.vue:fetchUserProfile()`
108 +
109 +---
110 +
111 +#### 接口 4: 退出登录
112 +
113 +**接口信息**
114 +- **接口名称**: `logoutAPI`
115 +- **接口路径**: `/srv/?a=user&t=logout`
116 +- **请求方法**: POST
117 +- **负责页面**: `src/pages/mine/index.vue`
118 +- **负责人**: 后端团队
119 +
120 +**接口文档更新记录**
121 +
122 +| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
123 +|------|------|---------|---------|---------|
124 +| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
125 +
126 +**页面调试情况**
127 +
128 +| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
129 +|------|---------|---------|---------|------|
130 +| 2026-02-03 | `src/pages/mine/index.vue` | 无 | - | ✅ 已完成 |
131 +
132 +**接口状态**: ✅ 已完成
133 +
134 +**备注**:
135 +- 解绑 openid 并清除登录状态
136 +- 调用成功后清除本地状态并跳转到首页
137 +- 实现位置:`src/pages/mine/index.vue:handleLogout()`
138 +
139 +---
140 +
141 +#### 接口 5: 登录(邮箱账号密码)
142 +
143 +**接口信息**
144 +- **接口名称**: `loginAPI`
145 +- **接口路径**: `/srv/?a=user&t=login`
146 +- **请求方法**: POST
147 +- **负责页面**: `src/pages/login/index.vue`
148 +- **负责人**: 后端团队
149 +
150 +**接口文档更新记录**
151 +
152 +| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
153 +|------|------|---------|---------|---------|
154 +| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
155 +
156 +**页面调试情况**
157 +
158 +| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
159 +|------|---------|---------|---------|------|
160 +| 2026-02-03 | `src/pages/login/index.vue` | 待联调 | - | 🔄 联调中 |
161 +
162 +**接口状态**: 🔄 联调中
163 +
164 +**备注**:
165 +- 邮箱账号密码登录
166 +- 参数:uuid(邮箱)、password(密码)
167 +- 登录成功后获取用户信息
168 +- 实现位置:`src/stores/user.js:login()`
169 +
170 +---
171 +
172 +#### 接口 6: 更新个人资料
173 +
174 +**接口信息**
175 +- **接口名称**: `updateProfileAPI`
176 +- **接口路径**: `/srv/?a=user&t=update_profile`
177 +- **请求方法**: POST
178 +- **负责页面**: `src/pages/avatar/index.vue`(待确认)
179 +- **负责人**: 后端团队
180 +
181 +**接口文档更新记录**
182 +
183 +| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
184 +|------|------|---------|---------|---------|
185 +| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
186 +
187 +**页面调试情况**
188 +
189 +| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
190 +|------|---------|---------|---------|------|
191 +| 2026-02-03 | - | 后端开发中 | - | ⏳ 后端开发中 |
192 +
193 +**接口状态**: ⏳ 后端开发中
194 +
195 +**备注**:
196 +- 参数:avatar_url(头像URL)
197 +- 用于用户修改头像
198 +- 后端接口开发中
199 +
200 +---
201 +
202 +### 意见反馈模块
203 +
204 +#### 接口 1: 意见反馈列表
205 +
206 +**接口信息**
207 +- **接口名称**: `listAPI`
208 +- **接口路径**: `/srv/?a=feedback&t=list`
209 +- **请求方法**: GET
210 +- **负责页面**: `src/pages/feedback/index.vue`(待确认)
211 +- **负责人**: 后端团队
212 +
213 +**接口文档更新记录**
214 +
215 +| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
216 +|------|------|---------|---------|---------|
217 +| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
218 +
219 +**页面调试情况**
220 +
221 +| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
222 +|------|---------|---------|---------|------|
223 +| 2026-02-03 | - | 后端开发中 | - | ⏳ 后端开发中 |
224 +
225 +**接口状态**: ⏳ 后端开发中
226 +
227 +**备注**:
228 +- 参数:page(页码)、limit(每页数量)
229 +- 返回反馈列表,包含状态、类别、图片、回复等信息
230 +- 后端接口开发中
231 +
232 +---
233 +
234 +#### 接口 2: 提交意见反馈
235 +
236 +**接口信息**
237 +- **接口名称**: `submitFeedbackAPI`
238 +- **接口路径**: `/srv/?a=feedback&t=add`
239 +- **请求方法**: POST
240 +- **负责页面**: `src/pages/feedback/index.vue`
241 +- **负责人**: 后端团队
242 +
243 +**接口文档更新记录**
244 +
245 +| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
246 +|------|------|---------|---------|---------|
247 +| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
248 +
249 +**页面调试情况**
250 +
251 +| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
252 +|------|---------|---------|---------|------|
253 +| 2026-02-03 | - | 后端开发中 | - | ⏳ 后端开发中 |
254 +
255 +**接口状态**: ⏳ 后端开发中
256 +
257 +**备注**:
258 +- 参数:category(反馈类别)、note(反馈内容)、contact(联系方式)、images(图片)
259 +- 类别:1=功能建议, 3=界面设计, 5=车辆新鲜, 7=其他问题
260 +- 后端接口开发中
261 +
262 +---
263 +
264 +### 消息模块
265 +
266 +#### 接口 1: 我的消息列表
267 +
268 +**接口信息**
269 +- **接口名称**: `myListAPI`
270 +- **接口路径**: `/srv/?a=website_msg&t=my_list`
271 +- **请求方法**: GET
272 +- **负责页面**: 待确认
273 +- **负责人**: 后端团队
274 +
275 +**接口文档更新记录**
276 +
277 +| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
278 +|------|------|---------|---------|---------|
279 +| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
280 +
281 +**页面调试情况**
282 +
283 +| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
284 +|------|---------|---------|---------|------|
285 +| 2026-02-03 | - | 后端开发中 | - | ⏳ 后端开发中 |
286 +
287 +**接口状态**: ⏳ 后端开发中
288 +
289 +**备注**:
290 +- 参数:page(页码)、limit(每页数量)
291 +- 返回用户消息列表
292 +- 后端接口开发中
293 +
294 +---
295 +
296 +#### 接口 2: 消息详情
297 +
298 +**接口信息**
299 +- **接口名称**: `detailAPI`
300 +- **接口路径**: `/srv/?a=website_msg&t=detail`
301 +- **请求方法**: GET
302 +- **负责页面**: 待确认
303 +- **负责人**: 后端团队
304 +
305 +**接口文档更新记录**
306 +
307 +| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
308 +|------|------|---------|---------|---------|
309 +| 2026-02-03 | v1.0 | 初始版本 | - | [查看](#) |
310 +
311 +**页面调试情况**
312 +
313 +| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
314 +|------|---------|---------|---------|------|
315 +| 2026-02-03 | - | 后端开发中 | - | ⏳ 后端开发中 |
316 +
317 +**接口状态**: ⏳ 后端开发中
318 +
319 +**备注**:
320 +- 参数:i(消息ID)
321 +- 返回消息详情
322 +- 后端接口开发中
323 +
324 +---
325 +
326 +### 模块模板
327 +
328 +复制下方模板添加新接口:
329 +
330 +```markdown
331 +#### 接口 X: [接口名称]
332 +
333 +**接口信息**
334 +- **接口名称**: `xxx`
335 +- **接口路径**: `/srv/?a=xxx`
336 +- **请求方法**: GET/POST
337 +- **负责页面**: `src/pages/xxx/index.vue`
338 +- **负责人**: XXX
339 +
340 +**接口文档更新记录**
341 +
342 +| 日期 | 版本 | 变更内容 | 变更原因 | 文档链接 |
343 +|------|------|---------|---------|---------|
344 +| YYYY-MM-DD | vX.X | - | - | [查看](#) |
345 +
346 +**页面调试情况**
347 +
348 +| 日期 | 调试页面 | 问题记录 | 解决方案 | 状态 |
349 +|------|---------|---------|---------|------|
350 +| YYYY-MM-DD | `pages/xxx/index.vue` | - | - | ⏳ 未开始 |
351 +
352 +**接口状态**: ⏳ 未开始
353 +
354 +**备注**:
355 +-
356 +```
357 +
358 +---
359 +
360 +## 🔍 问题汇总
361 +
362 +### 高优先级问题 🔴
363 +
364 +| 问题描述 | 接口名称 | 负责人 | 预计解决时间 |
365 +|---------|---------|--------|------------|
366 +| - | - | - | - |
367 +
368 +### 中优先级问题 🟡
369 +
370 +| 问题描述 | 接口名称 | 负责人 | 预计解决时间 |
371 +|---------|---------|--------|------------|
372 +| - | - | - | - |
373 +
374 +### 低优先级问题 🟢
375 +
376 +| 问题描述 | 接口名称 | 负责人 | 预计解决时间 |
377 +|---------|---------|--------|------------|
378 +| - | - | - | - |
379 +
380 +---
381 +
382 +## 📈 进度追踪
383 +
384 +### 本周进度 (2026-01-27 ~ 2026-02-02)
385 +
386 +- **新增接口**: 10
387 +- **完成联调**: 4
388 +- **联调中**: 1
389 +- **后端开发中**: 5
390 +- **发现问题**: 0
391 +- **解决问题**: 0
392 +
393 +### 历史进度
394 +
395 +| 周 | 完成数 | 新增数 | 问题数 |
396 +|----|--------|--------|--------|
397 +| 2026-01-27 ~ 2026-02-02 | 4 | 10 | 0 |
398 +
399 +---
400 +
401 +## 📌 快速索引
402 +
403 +### 按状态查看
404 +- [✅ 已完成](#用户中心模块) - 4个接口
405 +- [🔄 联调中](#用户中心模块) - 1个接口
406 +- [⏳ 后端开发中](#意见反馈模块) - 2个接口
407 +- [⏳ 后端开发中](#消息模块) - 2个接口
408 +- [⏳ 后端开发中](#用户中心模块) - 1个接口
409 +
410 +### 按模块查看
411 +- [用户中心](#用户中心模块) - ✅ 4个已完成, 🔄 1个联调中, ⏳ 1个后端开发中
412 +- [意见反馈](#意见反馈模块) - ⏳ 2个后端开发中
413 +- [消息](#消息模块) - ⏳ 2个后端开发中
414 +- [首页](#首页模块) - ⏳ 未开始
415 +- [产品详情](#产品模块) - ⏳ 未开始
416 +- [知识库](#知识库模块) - ⏳ 未开始
417 +- [家办](#家办模块) - ⏳ 未开始
418 +- [签单](#签单模块) - ⏳ 未开始
419 +
420 +### 按负责人查看
421 +- [ ] [张三](#张三负责的接口)
422 +- [ ] [李四](#李四负责的接口)
423 +
424 +---
425 +
426 +## 📖 使用说明
427 +
428 +### 状态标识
429 +-**已完成** - 接口正常工作,测试通过
430 +- 🔄 **联调中** - 正在调试,部分功能可用
431 +-**未开始** - 尚未开始联调
432 +- ⚠️ **有阻塞** - 遇到阻塞问题,无法继续
433 +
434 +### 优先级标识
435 +- 🔴 **高优先级** - 影响核心功能,需要立即处理
436 +- 🟡 **中优先级** - 影响次要功能,需要尽快处理
437 +- 🟢 **低优先级** - 优化类问题,可以稍后处理
438 +
439 +### 记录时机
440 +- **接口文档更新时**: 记录到"接口文档更新记录"表格
441 +- **页面联调时**: 记录到"页面调试情况"表格
442 +- **发现问题**: 记录到对应接口的调试情况,并同步到"问题汇总"
443 +- **解决问题**: 更新调试情况的状态,并从"问题汇总"中移除或标记为已解决
444 +
445 +### 维护建议
446 +1. **定期更新**: 每天结束前更新当天的工作记录
447 +2. **同步会议**: 在前后端对接会议上,根据此文档讨论问题
448 +3. **版本控制**: 重要的接口变更应该提交到 Git,便于追溯
449 +
450 +---
451 +
452 +**最后更新时间**: 2026-02-03 15:00
453 +**文档版本**: v1.2
454 +**更新内容**:
455 +- 新增 6 个接口记录(1个联调中,5个后端开发中)
456 +- 更新总体进度:10个接口(4个已完成,1个联调中,5个后端开发中)