151 lines
4.9 KiB
Markdown
151 lines
4.9 KiB
Markdown
# API 接口开发文档索引
|
||
|
||
## 📋 文档说明
|
||
|
||
本目录包含数据资源盘点系统中所有需要 Python 开发的接口的详细开发说明文档。每个接口都有独立的文档，包含完整的开发指导信息。
|
||
|
||
---
|
||
|
||
## 📚 接口文档列表
|
||
|
||
### 模块一：数据盘点智能分析服务
|
||
|
||
| 序号 | 接口名称 | 文档路径 | 是否大模型 | 优先级 | 工作量 |
|
||
|------|---------|---------|-----------|--------|--------|
|
||
| 1.1 | [文档解析接口](./01-parse-document.md) | `01-parse-document.md` | ❌ | 中 | 5 人日 |
|
||
| 1.2 | [SQL 结果解析接口](./02-parse-sql-result.md) | `02-parse-sql-result.md` | ❌ | 低 | 2 人日 |
|
||
| 1.3 | [业务表解析接口](./03-parse-business-tables.md) | `03-parse-business-tables.md` | ❌ | 中 | 3 人日 |
|
||
| 1.4 | [数据资产智能识别接口 ⭐⭐⭐](./04-ai-analyze.md) | `04-ai-analyze.md` | ✅ **是** | **高** | **15 人日** |
|
||
|
||
### 模块二：场景挖掘智能推荐服务
|
||
|
||
| 序号 | 接口名称 | 文档路径 | 是否大模型 | 优先级 | 工作量 |
|
||
|------|---------|---------|-----------|--------|--------|
|
||
| 2.1 | [潜在场景推荐接口 ⭐⭐](./05-scenario-recommendation.md) | `05-scenario-recommendation.md` | ✅ **是** | **高** | **12 人日** |
|
||
| 2.2 | [存量场景优化建议接口](./06-scenario-optimization.md) | `06-scenario-optimization.md` | ✅ **是** | 中 | 8 人日 |
|
||
|
||
### 模块三：数据资产盘点报告生成服务
|
||
|
||
| 序号 | 接口名称 | 文档路径 | 是否大模型 | 优先级 | 工作量 |
|
||
|------|---------|---------|-----------|--------|--------|
|
||
| 3.1 | [完整报告生成接口 ⭐⭐⭐](./07-generate-report.md) | `07-generate-report.md` | ✅ **是** | **高** | **20 人日** |
|
||
|
||
---
|
||
|
||
## 📊 文档内容结构
|
||
|
||
每个接口文档包含以下内容：
|
||
|
||
1. **接口基本信息**
|
||
- 接口路径、请求方法
|
||
- 功能描述、涉及页面
|
||
- 工作量评估、优先级
|
||
|
||
2. **功能描述**
|
||
- 详细的功能说明
|
||
- 适用场景
|
||
|
||
3. **技术实现方案**
|
||
- 技术栈推荐
|
||
- 实现思路
|
||
- 架构设计
|
||
|
||
4. **请求/响应格式**
|
||
- 详细的请求参数说明
|
||
- 响应格式定义
|
||
- 字段说明
|
||
|
||
5. **代码实现示例**
|
||
- FastAPI 实现代码
|
||
- 关键逻辑示例
|
||
- 最佳实践
|
||
|
||
6. **测试用例**
|
||
- 单元测试示例
|
||
- 集成测试建议
|
||
|
||
7. **注意事项**
|
||
- 常见问题和解决方案
|
||
- 性能优化建议
|
||
- 安全注意事项
|
||
|
||
8. **开发检查清单**
|
||
- 开发任务清单
|
||
- 验收标准
|
||
|
||
---
|
||
|
||
## 🎯 快速导航
|
||
|
||
### 按优先级排序
|
||
|
||
**高优先级（核心功能）**:
|
||
1. [数据资产智能识别接口](./04-ai-analyze.md) - 15 人日 ⭐⭐⭐
|
||
2. [完整报告生成接口](./07-generate-report.md) - 20 人日 ⭐⭐⭐
|
||
3. [潜在场景推荐接口](./05-scenario-recommendation.md) - 12 人日 ⭐⭐
|
||
|
||
**中优先级**:
|
||
4. [文档解析接口](./01-parse-document.md) - 5 人日
|
||
5. [业务表解析接口](./03-parse-business-tables.md) - 3 人日
|
||
6. [存量场景优化建议接口](./06-scenario-optimization.md) - 8 人日
|
||
|
||
**低优先级**:
|
||
7. [SQL 结果解析接口](./02-parse-sql-result.md) - 2 人日
|
||
|
||
### 按功能分类
|
||
|
||
**大模型接口（4个）**:
|
||
- [数据资产智能识别接口](./04-ai-analyze.md)
|
||
- [潜在场景推荐接口](./05-scenario-recommendation.md)
|
||
- [存量场景优化建议接口](./06-scenario-optimization.md)
|
||
- [完整报告生成接口](./07-generate-report.md)
|
||
|
||
**数据解析接口（3个）**:
|
||
- [文档解析接口](./01-parse-document.md)
|
||
- [SQL 结果解析接口](./02-parse-sql-result.md)
|
||
- [业务表解析接口](./03-parse-business-tables.md)
|
||
|
||
---
|
||
|
||
## 📈 开发建议
|
||
|
||
### 第一阶段（MVP 版本）- 4 周
|
||
|
||
**推荐顺序**:
|
||
1. [数据资产智能识别接口](./04-ai-analyze.md) - 核心功能
|
||
2. [完整报告生成接口](./07-generate-report.md) - 核心功能（简化版）
|
||
3. [文档解析接口](./01-parse-document.md) - 基础功能
|
||
|
||
### 第二阶段（完善版本）- 3 周
|
||
|
||
**推荐顺序**:
|
||
1. [潜在场景推荐接口](./05-scenario-recommendation.md)
|
||
2. [存量场景优化建议接口](./06-scenario-optimization.md)
|
||
3. [业务表解析接口](./03-parse-business-tables.md)
|
||
4. [SQL 结果解析接口](./02-parse-sql-result.md)
|
||
|
||
---
|
||
|
||
## 🔗 相关文档
|
||
|
||
- [接口清单表格](../Python接口清单表格.md) - 接口总览和统计
|
||
- [Python技术人员工作量文档](../Python技术人员工作量文档.md) - 详细工作量评估
|
||
- [数据资产盘点报告-大模型接口设计文档](../数据资产盘点报告-大模型接口设计文档.md) - 报告生成接口详细设计
|
||
|
||
---
|
||
|
||
## 📞 联系方式
|
||
|
||
如有接口开发相关问题，请联系：
|
||
- **Python 技术负责人**: [待填写]
|
||
- **大模型技术顾问**: [待填写]
|
||
- **接口对接负责人**: [待填写]
|
||
|
||
---
|
||
|
||
## 📅 更新记录
|
||
|
||
| 版本 | 日期 | 更新内容 | 作者 |
|
||
|------|------|---------|------|
|
||
| v1.0 | 2025-01-XX | 初始版本，包含 7 个接口的完整开发说明文档 | AI Assistant |
|