5314077f3b
- 更新根目录README.md，完善项目说明 - 更新api/README.md，添加API文档说明 - 新增api/docs/README.md文档 - 新增app-android/README.md文档 - 新增app-android/doc/文档目录
85 lines
2.4 KiB
Markdown
85 lines
2.4 KiB
Markdown
# API 文档索引
|
||
|
||
> Life Echo API 详细文档目录
|
||
|
||
## 📚 文档导航
|
||
|
||
### 🚀 快速开始
|
||
|
||
- **[本地开发环境配置](./本地开发环境配置.md)** - 详细的开发环境搭建指南
|
||
- 架构概述
|
||
- 前置要求
|
||
- 快速启动步骤
|
||
- 服务说明（FastAPI、Redis、Celery）
|
||
- 生产环境部署
|
||
- 常见问题
|
||
|
||
### 🔌 WebSocket 文档
|
||
|
||
- **[WebSocket 快速测试指南](./WebSocket快速测试指南.md)** - 快速上手 WebSocket 测试
|
||
- 连接地址
|
||
- 消息类型速查
|
||
- 测试场景
|
||
- 常见问题
|
||
|
||
- **[WebSocket 测试文档](./WebSocket测试文档.md)** - WebSocket 接口详细文档
|
||
- 接口信息
|
||
- 消息类型定义
|
||
- 消息格式规范
|
||
- 完整测试示例
|
||
- 错误处理
|
||
|
||
### 💬 功能说明
|
||
|
||
- **[文字交流模式说明](./文字交流模式说明.md)** - 文字对话模式详细说明
|
||
- 功能特性
|
||
- WebSocket 消息格式
|
||
- 使用流程
|
||
- 已移除/保留的功能
|
||
- 注意事项
|
||
|
||
### 🧪 测试文档
|
||
|
||
- **[测试脚本使用说明](./测试脚本使用说明.md)** - 自动化测试脚本使用指南
|
||
- 前置条件
|
||
- 运行测试
|
||
- 测试流程
|
||
- 自定义测试内容
|
||
- 常见问题
|
||
|
||
## 📖 文档分类
|
||
|
||
### 按用途分类
|
||
|
||
| 文档 | 用途 | 适合人群 |
|
||
|------|------|----------|
|
||
| 本地开发环境配置 | 环境搭建 | 新开发者 |
|
||
| WebSocket 快速测试指南 | 快速测试 | 前端开发者、测试人员 |
|
||
| WebSocket 测试文档 | 详细接口文档 | 后端开发者、集成开发者 |
|
||
| 文字交流模式说明 | 功能说明 | 所有开发者 |
|
||
| 测试脚本使用说明 | 自动化测试 | 测试人员、CI/CD |
|
||
|
||
### 按阶段分类
|
||
|
||
**开发阶段**：
|
||
1. [本地开发环境配置](./本地开发环境配置.md) - 搭建开发环境
|
||
2. [文字交流模式说明](./文字交流模式说明.md) - 了解功能特性
|
||
|
||
**测试阶段**：
|
||
1. [WebSocket 快速测试指南](./WebSocket快速测试指南.md) - 快速测试
|
||
2. [WebSocket 测试文档](./WebSocket测试文档.md) - 详细测试
|
||
3. [测试脚本使用说明](./测试脚本使用说明.md) - 自动化测试
|
||
|
||
## 🔗 相关链接
|
||
|
||
- [API README](../README.md) - API 服务主文档
|
||
- [项目根目录 README](../../README.md) - 项目总览
|
||
|
||
## 📝 文档更新
|
||
|
||
文档会随着项目发展持续更新。如有问题或建议，请提交 Issue 或 Pull Request。
|
||
|
||
---
|
||
|
||
**Life Echo API 文档** - 让开发更简单 📚✨
|