Browse Source

docs(prd): 更新史诗015人才小程序API只读设计

- 遵循用人方小程序设计原则,调整为以查询功能为主
- 更新故事015-03:个人信息管理API改为只读查询
- 更新故事015-06:系统设置API改为帮助与支持API
- 更新故事015-08:远程打卡API改为打卡状态查询API
- 明确只读设计原则,所有数据修改由管理员在后台处理

🤖 Generated with [Claude Code](https://claude.ai/code)
via [Happy](https://happy.engineering)

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Happy <yesreply@happy.engineering>
yourname 3 weeks ago
parent
commit
51459387e7
1 changed files with 46 additions and 63 deletions
  1. 46 63
      docs/prd/epic-015-talent-mini-program-api-support.md

+ 46 - 63
docs/prd/epic-015-talent-mini-program-api-support.md

@@ -41,12 +41,15 @@
 为人才小程序补充6大类API接口,包括:
 1. 数据库schema扩展:扩展用户表支持人才用户类型、添加打卡记录相关字段
 2. 人才用户认证API:支持人才用户身份证号/残疾证号密码登录、获取人才用户信息
-3. 个人信息管理API:人才基本信息查询与更新、银行卡管理、证件照片管理
+3. 个人信息查询API:人才基本信息查询、银行卡信息查询、证件照片查询
 4. 考勤记录API:打卡记录查询、考勤统计、考勤日历、打卡明细
 5. 就业信息API:当前就业状态查询、薪资记录查询、就业历史查询
-6. 系统设置API:个人信息修改、账号安全设置、消息通知设置
+6. 帮助与支持API:帮助中心查询、协议政策查询、登录日志查询
 7. API文档与测试:OpenAPI文档、TypeScript类型定义、单元测试
 
+**只读设计原则:**
+遵循与用人方小程序相同的设计原则,人才小程序API以查询功能为主,所有数据修改操作(个人信息更新、银行卡管理、证件照片管理、打卡记录等)由管理员在管理后台统一处理。人才用户仅有的写入操作包括:登录认证、通知标记已读。
+
 **API路径约定:**
 所有人才小程序的API路径统一使用 `api/v1/rencai` 前缀,与现有管理后台和用人方小程序API路径做区分。例如:
 - 人才用户登录:`POST /api/v1/rencai/auth/login`
@@ -69,6 +72,9 @@
 **API路径约定说明:**
 所有新增的人才小程序API必须遵循 `api/v1/rencai` 前缀约定,确保与现有管理后台和用人方小程序API路径隔离。每个故事在实现API接口时需确保路径前缀正确。
 
+**只读设计说明:**
+遵循与用人方小程序相同的设计原则,人才小程序API以查询功能为主。所有数据修改操作(个人信息更新、银行卡管理、证件照片管理、打卡记录等)由管理员在管理后台统一处理。人才用户仅有的写入操作包括:登录认证、通知标记已读。
+
 **故事概览:**
 本史诗包含12个故事,其中10个为核心故事(015-01到015-10),1个延期故事(015-11),1个冗余故事(015-12)。
 
@@ -112,36 +118,28 @@
 - [ ] API文档完整,包含OpenAPI定义和TypeScript类型
 
 ### 故事015-03:个人信息管理API
-**背景:** 人才用户需要查看和管理个人信息,包括基本信息、银行卡信息、证件照片等。
+**背景:** 人才用户需要查看个人信息,包括基本信息、银行卡信息、证件照片等。所有个人信息由管理员在管理后台统一维护,人才小程序只提供查询功能。
 
 **任务列表:**
 1. **个人信息查询API**(disability-module扩展):
    - 基于`disabled_person`表查询人才基本信息
    - 接口返回:姓名、性别、年龄、身份证号、残疾证号、残疾类型、联系电话、联系地址等
 
-2. **个人信息更新API**(disability-module扩展):
-   - 支持人才用户更新个人信息(如联系电话、联系地址等)
-   - 验证更新权限,确保用户只能更新自己的信息
-
-3. **银行卡管理API**(disability-module扩展):
+2. **银行卡信息查询API**(disability-module扩展):
    - 基于`disabled_bank_card`表查询人才银行卡信息
-   - 添加银行卡接口(关联`files`表存储银行卡照片)
-   - 设置默认银行卡接口
-   - 删除银行卡接口(需验证权限)
+   - 接口返回:银行名称、卡号(脱敏)、卡类型、是否默认等
 
-4. **证件照片管理API**(disability-module扩展):
+3. **证件照片查询API**(disability-module扩展):
    - 基于`disabled_person_photo`表查询人才证件照片
-   - 添加证件照片接口(身份证、残疾证、体检报告、征信报告等)
-   - 删除证件照片接口(需验证权限)
+   - 接口返回:照片类型(身份证、残疾证、体检报告、征信报告等)、文件信息
 
-5. 编写单元测试和集成测试
+4. 编写单元测试和集成测试
 
 **验收标准:**
 - [ ] 个人信息查询接口返回正确的人才基本信息
-- [ ] 个人信息更新接口支持更新个人可修改信息
-- [ ] 银行卡管理接口支持查询、添加、设置默认、删除银行卡
-- [ ] 证件照片管理接口支持查询、添加、删除证件照片
-- [ ] 所有接口验证用户权限,确保用户只能操作自己的数据
+- [ ] 银行卡信息查询接口返回银行卡信息(卡号脱敏处理)
+- [ ] 证件照片查询接口返回证件照片信息
+- [ ] 所有接口验证用户权限,确保用户只能查询自己的数据
 - [ ] 所有接口通过单元测试和集成测试
 
 ### 故事015-04:考勤记录API
@@ -215,36 +213,27 @@
 - [ ] 查询性能优化,添加必要的数据索引
 - [ ] 所有接口通过单元测试和集成测试
 
-### 故事015-06:系统设置API
-**背景:** 人才用户需要进行个人设置管理,包括个人信息修改、账号安全设置、消息通知设置等
+### 故事015-06:帮助与支持API
+**背景:** 人才用户需要查看帮助文档、用户协议、隐私政策等内容。所有账号安全设置和个人信息修改由管理员在管理后台统一维护
 
 **任务列表:**
-1. **个人信息修改API**(disability-module扩展):
-   - 支持人才用户修改个人信息(联系电话、联系地址等)
-   - 添加个人信息修改历史记录
-
-2. **账号安全设置API**(auth-module扩展):
-   - 修改密码接口
-   - 登录设备管理接口(查询登录设备、退出设备)
-   - 登录日志查询接口
+1. **帮助中心查询API**:
+   - 帮助中心内容查询接口,提供使用指南和常见问题解答
 
-3. **消息通知设置API**(创建或扩展现有模块):
-   - 消息通知开关设置(薪资发放通知、考勤异常通知、系统公告等)
-   - 通知偏好设置接口
-
-4. **帮助与支持API**:
-   - 帮助中心内容查询接口
+2. **协议政策查询API**:
    - 用户协议查询接口
    - 隐私政策查询接口
-   - 问题反馈接口
 
-5. 编写单元测试和集成测试
+3. **登录日志查询API**(auth-module扩展):
+   - 查询个人的登录日志记录,支持分页
+   - 接口返回:登录时间、登录设备、登录IP等
+
+4. 编写单元测试和集成测试
 
 **验收标准:**
-- [ ] 个人信息修改接口支持修改个人可修改信息
-- [ ] 账号安全设置接口支持修改密码、管理登录设备、查询登录日志
-- [ ] 消息通知设置接口支持各类通知的开关控制
-- [ ] 帮助与支持接口提供帮助中心、用户协议、隐私政策等内容
+- [ ] 帮助中心查询接口返回帮助文档内容
+- [ ] 协议政策查询接口返回用户协议和隐私政策
+- [ ] 登录日志查询接口返回个人的登录日志记录
 - [ ] 所有接口通过单元测试和集成测试
 
 ### 故事015-07:通知与消息API
@@ -280,35 +269,29 @@
 - [ ] 消息推送集成,重要通知实时推送到小程序
 - [ ] 所有接口通过单元测试和集成测试
 
-### 故事015-08:远程打卡API
-**背景:** 人才用户需要通过小程序进行远程打卡,记录上班和下班时间
+### 故事015-08:打卡状态查询API
+**背景:** 人才用户需要查询当天的打卡状态和历史打卡记录。打卡操作由管理员在管理后台统一处理,小程序只提供打卡状态查询功能
 
 **任务列表:**
-1. **远程打卡API**(order-module扩展):
-   - 上班打卡接口:记录上班打卡时间
-   - 下班打卡接口:记录下班打卡时间
-   - 打卡状态验证:验证是否在合理时间内打卡(如上班时间前1小时内打卡)
-   - 打卡位置验证:如需要,可集成位置验证
+1. **当天打卡状态查询API**(order-module扩展):
+   - 查询当天的打卡状态:是否已打卡、打卡时间、打卡类型(上班/下班)
+   - 接口返回:打卡状态、打卡时间、打卡结果(正常、迟到、早退等)
 
-2. **打卡记录查询API**:
-   - 查询当天的打卡记录
-   - 查询历史打卡记录
+2. **打卡异常记录查询API**(order-module扩展):
+   - 查询个人的打卡异常记录:迟到、早退、缺勤等
+   - 支持按月份查询异常记录
+   - 接口返回:异常日期、异常类型、异常说明(如有)
 
-3. **打卡异常处理**
-   - 打卡异常记录:迟到、早退、缺勤等异常情况记录
-   - 异常打卡说明:允许用户提交异常说明
+3. **打卡提醒查询API**(order-module扩展)
+   - 查询打卡提醒设置(如管理员配置的提醒规则)
+   - 接口返回:提醒时间、提醒类型等
 
-4. **打卡提醒功能**:
-   - 打卡提醒设置接口
-   - 定时打卡提醒推送
-
-5. 编写单元测试和集成测试
+4. 编写单元测试和集成测试
 
 **验收标准:**
-- [ ] 远程打卡接口支持上班和下班打卡
-- [ ] 打卡记录查询接口返回打卡记录
-- [ ] 打卡异常处理支持异常记录和说明提交
-- [ ] 打卡提醒功能支持提醒设置和定时推送
+- [ ] 当天打卡状态查询接口返回正确的打卡状态信息
+- [ ] 打卡异常记录查询接口返回打卡异常记录
+- [ ] 打卡提醒查询接口返回打卡提醒设置信息
 - [ ] 所有接口通过单元测试和集成测试
 
 ### 故事015-09:数据统计与报表API