评审会议记录
文档编号: SYS-INT-REV-004
会议名称: System平台接口设计评审会议
会议日期: 2026年3月10日
会议时间: 14:00-16:00
会议地点: 会议室A
记录人: 系统架构师 李工
主持人: 技术总监 张总
一、会议基本信息
1.1 参会人员
| 序号 | 姓名 | 角色 | 部门 | 签到 |
|---|---|---|---|---|
| 1 | 张总 | 技术总监/评审主席 | 技术部 | ✅ |
| 2 | 李工 | 系统架构师 | 架构组 | ✅ |
| 3 | 王工 | 后端架构师 | 后端组 | ✅ |
| 4 | 陈工 | 前端负责人 | 前端组 | ✅ |
| 5 | 赵工 | 安全工程师 | 安全组 | ✅ |
| 6 | 刘经理 | 产品经理 | 产品部 | ✅ |
| 7 | 周工 | 测试负责人 | 测试组 | ✅ |
应到: 7人 实到: 7人 缺席: 0人
1.2 会议议程回顾
| 阶段 | 内容 | 计划时间 | 实际时间 |
|---|---|---|---|
| 1 | 开场介绍 | 14:00-14:10 | 14:00-14:08 |
| 2 | 接口规范标准评审 | 14:10-14:30 | 14:08-14:28 |
| 3 | API接口清单评审 | 14:30-14:45 | 14:28-14:42 |
| 4 | 模块接口详细评审 | 14:45-15:30 | 14:42-15:28 |
| 5 | 问题讨论与澄清 | 15:30-15:50 | 15:28-15:48 |
| 6 | 评审结论 | 15:50-16:00 | 15:48-15:58 |
会议准时结束,总时长约1小时58分钟。
二、会议内容记录
2.1 开场介绍(14:00-14:08)
主持人: 张总
会议内容:
- 张总宣布会议开始,介绍评审目标和规则
- 李工介绍评审范围和评审标准
- 确认参会人员全部到齐
决议:
- 评审正式开始
- 采用有条件通过的评审标准
2.2 接口规范标准评审(14:08-14:28)
主讲人: 李工、赵工
2.2.1 RESTful API设计规范
李工汇报:
- URL设计采用
/api/v{version}/{resource}格式 - 资源命名使用复数名词,如
/users、/roles - HTTP方法使用规范:GET查询、POST创建、PUT更新、DELETE删除
- 响应格式统一为
{code, message, data, timestamp}
讨论:
- 王工: 版本号在URL中的设计是否会影响未来的灵活性?
- 李工: 采用URL路径版本是最清晰的方式,也便于API网关路由。未来如果有多版本并存,可以通过网关层处理。
- 陈工: 前端支持这种设计,版本明确有利于缓存管理。
决议: RESTful API设计规范通过,无需修改。
2.2.2 接口安全规范
赵工汇报:
- JWT认证机制:Access Token有效期2小时,Refresh Token有效期7天
- 请求签名采用HMAC-SHA256算法
- 防重放攻击:时间戳5分钟容差 + Nonce机制
- 限流策略:全局、API、用户、IP四个维度
讨论:
- 赵工: 建议在生产环境启用HTTPS强制跳转
- 李工: 同意,会在部署文档中明确
- 周工: Token刷新机制需要测试覆盖
决议: 接口安全规范通过,无需修改。
2.2.3 接口版本管理规范
李工汇报:
- 版本号规则:语义化版本 MAJOR.MINOR.PATCH
- API版本格式:v{MAJOR},如 v1、v2
- 兼容性策略:向后兼容的修改升级MINOR,不兼容修改升级MAJOR
- 废弃流程:提前2个版本通知,保留1个版本后下线
讨论:
- 张总: 版本废弃周期是否合理?
- 李工: 考虑到项目迭代速度,2个版本通知+1个版本保留应该足够
- 刘经理: 需要确保前端有足够时间适配
决议: 接口版本管理规范通过,无需修改。
2.3 API接口清单评审(14:28-14:42)
主讲人: 李工
汇报内容:
- 总计45个API接口
- 用户管理模块:15个接口
- 角色权限模块:12个接口
- 组织架构模块:10个接口
- 系统管理模块:8个接口
讨论:
- 陈工: 接口数量是否合理?是否有过多的细粒度接口?
- 李工: 每个接口都对应明确的业务功能,没有过度设计
- 王工: 后端实现角度,接口粒度合适,便于权限控制
决议: API接口清单通过,接口数量和划分合理。
2.4 模块接口详细评审(14:42-15:28)
2.4.1 用户管理模块(14:42-14:56)
主讲人: 李工
汇报内容:
- 用户注册接口:支持邮箱和手机号注册
- 用户登录接口:支持密码登录,返回JWT Token
- 用户CRUD接口:完整的增删改查
- 用户状态管理:启用/禁用/锁定
讨论:
- 赵工: 密码传输是否加密?
- 李工: 使用HTTPS传输,密码在传输前前端进行RSA加密
- 周工: 用户锁定策略是什么?
- 李工: 连续5次登录失败锁定30分钟
决议: 用户管理模块接口通过,无需修改。
2.4.2 角色权限模块(14:56-15:06)
主讲人: 李工
汇报内容:
- 角色CRUD接口
- 权限分配接口:支持菜单权限和数据权限
- 角色权限查询接口
讨论:
- 王工: 权限码格式是否统一?
- 李工: 格式为
{module}:{action},如user:read、user:create - 陈工: 前端需要根据权限码控制按钮显示
决议: 角色权限模块接口通过,无需修改。
2.4.3 组织架构模块(15:06-15:18)
主讲人: 李工
汇报内容:
- 部门树查询接口:支持懒加载
- 部门CRUD接口
- 岗位管理接口
讨论:
- 王工: 部门树查询如果数据量很大怎么办?
- 李工: 目前设计是懒加载,但缺少层级深度限制
- 张总: 建议添加最大层级限制,防止递归过深
- 李工: 同意,添加
maxDepth参数,默认值10
问题记录:
- 问题1: 部门树查询接口缺少层级深度限制参数
- 问题2: 部门排序建议增加
sortOrder字段
决议: 组织架构模块接口有条件通过,需修改2处。
2.4.4 系统管理模块(15:18-15:28)
主讲人: 李工
汇报内容:
- 字典类型和数据管理接口
- 系统参数配置接口
- 操作日志和登录日志查询接口
讨论:
- 周工: 操作日志查询是否支持按操作类型筛选?
- 李工: 目前只支持按时间和用户筛选
- 刘经理: 业务上需要按操作类型筛选,比如只看新增和删除操作
- 李工: 同意添加
operationType查询参数
问题记录:
- 问题3: 操作日志查询接口建议增加操作类型筛选
决议: 系统管理模块接口有条件通过,需修改1处。
2.5 问题讨论与澄清(15:28-15:48)
主持人: 张总
讨论议题:
议题1: 问题修改优先级
张总: 3个问题都需要在本次评审后修改吗? 李工: 是的,都是轻微问题,预计1天内可以完成修改。 张总: 同意,修改后由王工验证。
议题2: 接口文档维护
陈工: 接口文档在开发过程中如何保持更新? 李工: 采用Swagger自动生成接口文档,代码即文档。 王工: 后端会确保注解完整,保证文档准确性。
议题3: 前后端对接计划
张总: 接口评审通过后,前后端对接计划是什么? 李工: 建议先开发用户管理和角色权限模块,这两个是基础模块。 陈工: 同意,前端可以先进行Mock开发。
决议:
- 李工负责在3月12日前完成3个问题的修改
- 王工负责在3月13日前完成问题验证
- 验证通过后建立接口基线
- 开发阶段采用Swagger维护接口文档
2.6 评审结论(15:48-15:58)
主持人: 张总
评审意见汇总:
| 评审项 | 结果 | 说明 |
|---|---|---|
| RESTful API设计规范 | 通过 | 符合标准 |
| 接口安全规范 | 通过 | 机制完善 |
| 接口版本管理规范 | 通过 | 策略合理 |
| API接口清单 | 通过 | 覆盖完整 |
| 用户管理模块 | 通过 | 设计合理 |
| 角色权限模块 | 通过 | 模型清晰 |
| 组织架构模块 | 有条件通过 | 需修改2处 |
| 系统管理模块 | 有条件通过 | 需修改1处 |
评审结论宣布:
张总宣布评审结论:有条件通过
System平台接口设计整体质量良好,基本满足项目需求。存在3个轻微问题需要修改,修改完成后可建立接口基线。
后续行动:
- 李工在2026-03-12前完成3个问题修改
- 王工在2026-03-13前完成问题验证
- 验证通过后建立接口基线
三、会议决议
3.1 决议清单
| 序号 | 决议内容 | 责任人 | 完成时间 | 状态 |
|---|---|---|---|---|
| 1 | 修改部门树查询接口,添加maxDepth参数 | 李工 | 2026-03-12 | ⏳ 待执行 |
| 2 | 修改Department实体,添加sortOrder字段 | 李工 | 2026-03-12 | ⏳ 待执行 |
| 3 | 修改操作日志查询接口,添加operationType参数 | 李工 | 2026-03-12 | ⏳ 待执行 |
| 4 | 验证问题修改结果 | 王工 | 2026-03-13 | ⏳ 待执行 |
| 5 | 建立接口基线 | 李工 | 2026-03-13 | ⏳ 待执行 |
| 6 | 采用Swagger自动生成接口文档 | 王工 | 开发阶段 | ⏳ 待执行 |
3.2 基线建立条件
- [ ] 所有问题已修改完成
- [ ] 问题修改已验证通过
- [ ] 接口文档已更新
- [ ] 评审报告已签字确认
四、会议附件
4.1 附件清单
五、会议记录确认
5.1 记录确认签字
| 角色 | 姓名 | 签字 | 日期 |
|---|---|---|---|
| 记录人 | 李工 | ____________ | |
| 主持人 | 张总 | ____________ |
5.2 记录准确性确认
本会议记录经参会人员确认,内容准确无误。
确认签字: ____________ 日期: ____________
六、修订记录
| 版本 | 日期 | 作者 | 变更内容 |
|---|---|---|---|
| 1.0 | 2026-03-10 | 系统架构师 | 初始版本,记录评审会议内容 |
