docs: 邢远鑫第9周详细工作计划

pull/39/head
hnu202326010131 3 months ago
parent 4dd5075ee9
commit 18bc2bfb93

@ -0,0 +1,143 @@
# 邢远鑫第9周详细工作计划
## 基本信息
- **姓名**: 邢远鑫
- **计划周期**: 第9周2025-11-17 至 2025-11-23
- **项目**: 大模型数据平台故障检测项目
- **计划制定时间**: 2025-11-17
- **工作时间**: 每天20:00-21:301.5小时/天共10.5小时)
## 本周核心目标
### 主要任务概览
本周采用“**学习前3天 + 实践后4天**”两阶段模式,围绕前后端接口对接能力进行系统性提升与落地。
### 核心目标
1. **接口规范系统学习前3天**:掌握 RESTful 设计、接口文档阅读、前端调用最佳实践与 Postman 使用
2. **接口对接会议与开发后4天**:与后端明确 URL/方法/参数/响应/错误处理,并完成前端对接与异常处理
3. **交付文档与稳定性验证**:形成接口对接文档,确保调用稳定可靠
### 质量目标
- 形成可复用的 API 调用封装与错误处理策略
- 与后端达成一致的参数与错误码口径
- 完成对接模块的最小功能闭环(认证、集群、日志、指标、诊断/修复)
---
## 周一2025-11-17
**主题RESTful 与接口规范**
### 20:00-21:30RESTful API 设计规范系统学习
- **学习任务**理解资源、路径、方法GET/POST/PUT/DELETE、状态码与错误码约定
- **学习途径**:阅读 REST 设计最佳实践与团队规范示例
- **具体方法**
1. 资源命名与层级路径示例:`/api/cluster/nodes/{id}`
2. 状态码与错误码映射2xx/4xx/5xx 与业务 `code`
3. 请求/响应一致性:统一 Header/Content-Type/数据结构
- **产出**RESTful 学习笔记与规范摘要
---
## 周二2025-11-18
**主题:接口文档阅读与前端调用最佳实践**
### 20:00-21:30接口文档理解与前端封装
- **学习任务**:阅读接口文档,明确参数/响应与术语;前端调用封装(超时、重试、错误处理)
- **学习途径**:结合项目 `src/fronted/utils/*` 结构与已有文档
- **具体方法**
1. 统一响应结构 `{ code, msg, data }` 的处理逻辑
2. 封装 `fetch``Authorization`、JSON 序列化、统一错误提示
3. 幂等接口重试策略与超时控制10s
- **产出**:前端 `api` 封装示例与调用清单草稿
---
## 周三2025-11-19
**主题Postman 调试与连贯性梳理**
### 20:00-21:30Postman 环境与集合配置 + 第7/8周连贯性梳理
- **学习任务**:配置测试/生产环境变量与集合整理与第7/8周目标的连续性
- **学习途径**Postman 官方文档与团队约定
- **具体方法**
1. 建立集合Auth/Cluster/Logs/Metrics/Diagnosis/Repair
2. 变量:`{{base_url}}`、`{{token}}`
3. 衔接第7/8周从基础学习到接口实践的路径与目标一致性
- **产出**Postman 集合与环境文件、连贯性梳理记录
---
## 周四2025-11-20
**主题:接口对接会议与纪要**
### 20:00-21:30与后端接口对接会议
- **会议议题**
- 接口 URL 与方法
- 请求参数格式与必填项
- 响应数据结构与状态码
- 错误处理机制与重试策略
- **产出**:会议纪要与决议(确认的接口清单、参数表、错误码口径)
---
## 周五2025-11-21
**主题前端接口实现Auth/Cluster**
### 20:00-21:30实现与验证
- **任务**
- 完成 Auth 登录/登出/刷新与 `me` 查询接口调用
- 完成 Cluster 概览与节点列表调用
- **产出**:接口请求代码、调用示例、错误处理与用户提示
---
## 周六2025-11-22
**主题前端接口实现Logs/Metrics**
### 20:00-21:30实现与验证
- **任务**
- 完成 Logs 检索/详情/下载调用
- 完成 Metrics 历史与实时SSE/WS示例对接
- **产出**接口请求代码、图表数据适配ECharts、分页与流式处理策略
---
## 周日2025-11-23
**主题前端接口实现Diagnosis/Repair与周总结**
### 20:00-21:30实现与验证 + 进度与问题记录
- **任务**
- 完成 Diagnosis 触发与结果查询
- 完成 Repair 执行与状态查询
- 整理本周接口对接进度与问题清单(含解决方案)
- **产出**:接口请求代码、问题与对策记录、接口对接文档初版(关键字段与流程)
---
## 风险评估与应对策略
- **接口口径不一致**:提前明确字段与错误码;建立变更记录与版本号
- **后端环境不稳定**:准备测试数据与降级策略;对实时接口设置断线重连
- **时间不足**优先实现核心路径Auth/Cluster/Logs非核心延后迭代
## 学习资源与参考资料
- RESTful 设计最佳实践(团队规范与社区文章)
- Postman 官方文档与示例集合
- 项目文档:`doc/api/fronted-interface.md`
## 预期成果与交付物
### 主要交付物
| 类别 | 交付物 | 具体内容 |
|------|--------|----------|
| **接口封装** | API 调用封装 | 统一 Header/错误处理/重试策略/超时控制 |
| **接口实现** | 前端对接代码 | Auth/Cluster/Logs/Metrics/Diagnosis/Repair 最小闭环 |
| **文档与记录** | 对接文档与问题清单 | 接口清单、参数表、错误码、流程图与会议纪要 |
### 质量标准
- 可用性:接口调用稳定可靠,错误提示清晰
- 可维护性:封装清晰、模块边界明确、文档完备
- 一致性:与后端约定一致,字段与状态码口径统一
---
**计划制定时间**: 2025-11-17
**计划执行周期**: 2025-11-17 至 2025-11-23
**个人目标**: 完成从接口规范学习到实际对接落地的闭环,形成标准化的前端接口实现与文档输出能力
Loading…
Cancel
Save