# 文档中心

欢迎使用 Unified Backend Platform 文档中心！

---

## 📖 快速导航

### 我是前端/移动端开发者

我想将我的应用接入统一后端：

| 步骤 | 文档 | 说明 |
|------|------|------|
| 1️⃣ | [5分钟快速接入指南](QUICKSTART.md) | 快速上手，5分钟完成接入 |
| 2️⃣ | [开发者接入指南](DEVELOPER_GUIDE.md) | 完整的接入文档，包含所有功能 |
| 3️⃣ | [API 参考手册](API_REFERENCE.md) | API 接口详细说明 |

### 我是后端开发者

我想参与后端开发或部署：

| 文档 | 说明 |
|------|------|
| [项目架构文档](../CLAUDE.md) | 详细的架构设计和开发说明 |
| [部署文档](../DEPLOYMENT.md) | 生产环境部署指南 |

### 我是运维人员

我需要部署和维护服务：

| 文档 | 说明 |
|------|------|
| [部署文档](../DEPLOYMENT.md) | 完整的部署指南 |
| [README](../README.md) | 项目概述和配置说明 |

---

## 📚 文档详细说明

### 1. 5分钟快速接入指南

**文件**: [QUICKSTART.md](QUICKSTART.md)

**适合**: 前端/移动端开发者

**内容**:
- 快速创建 Casdoor 应用
- 集成用户登录（复制粘贴代码）
- 数据 CRUD 操作（简单示例）
- 文件上传下载（简单示例）
- 完整 TODO 应用示例

**阅读时间**: 5-10 分钟

---

### 2. 开发者接入指南

**文件**: [DEVELOPER_GUIDE.md](DEVELOPER_GUIDE.md)

**适合**: 前端/移动端开发者

**内容**:
- 用户认证完整流程
- Casdoor 应用配置详解
- 数据库 CRUD 完整操作
  - 创建、查询、更新、删除
  - 批量操作
  - 分页、排序、搜索
- 文件管理完整操作
  - 直接上传
  - 预签名上传（大文件）
  - 文件下载
  - 元数据管理
- 完整博客应用示例
- 常见问题解答

**阅读时间**: 20-30 分钟

---

### 3. API 参考手册

**文件**: [API_REFERENCE.md](API_REFERENCE.md)

**适合**: 所有开发者

**内容**:
- 认证 API
- 记录管理 API
  - 创建、查询、更新、删除
  - 批量操作
- 文件管理 API
  - 上传、下载、更新、删除
  - 预签名 URL
- 错误处理
- 数据限制
- cURL 示例

**阅读时间**: 查阅参考

---

### 4. 部署文档

**文件**: [DEPLOYMENT.md](../DEPLOYMENT.md)

**适合**: 运维/后端开发者

**内容**:
- 环境要求
- 配置说明
- 部署步骤
- 数据备份
- 生产环境配置
- 故障排查

---

### 5. 项目架构文档

**文件**: [CLAUDE.md](../CLAUDE.md)

**适合**: 后端开发者

**内容**:
- 项目架构设计
- 核心概念
- 常用命令
- 开发指南
- 目录结构
- 技术栈说明

---

## 🎯 按场景查找文档

### 场景 1: 我想开发一个新的应用

1. 阅读 [5分钟快速接入指南](QUICKSTART.md)
2. 在 Casdoor 创建应用
3. 集成登录功能
4. 开始使用 API 存储数据

### 场景 2: 我需要实现用户登录

1. 阅读 [开发者接入指南 - 用户认证](DEVELOPER_GUIDE.md#一用户认证接入)
2. 在 Casdoor 创建应用
3. 集成 OAuth 登录
4. 使用 JWT Token 调用 API

### 场景 3: 我需要存储和查询数据

1. 阅读 [开发者接入指南 - 数据库操作](DEVELOPER_GUIDE.md#二数据库-crud-操作)
2. 定义 `app_identifier` 和 `collection_type`
3. 使用 API 创建、查询记录

### 场景 4: 我需要上传文件

1. 阅读 [开发者接入指南 - 文件管理](DEVELOPER_GUIDE.md#三文件管理)
2. 小文件使用直接上传
3. 大文件使用预签名上传

### 场景 5: 我需要部署到生产环境

1. 阅读 [部署文档](../DEPLOYMENT.md)
2. 修改 `.env` 配置
3. 启动服务
4. 配置监控和备份

### 场景 6: 我想查询某个 API 的用法

1. 阅读 [API 参考手册](API_REFERENCE.md)
2. 找到对应的 API 端点
3. 查看请求/响应示例

---

## 💡 学习路径建议

### 初级开发者

```
1. 5分钟快速接入指南 (了解基本概念)
2. API 参考手册 (熟悉 API 接口)
3. 动手实践 (开发第一个应用)
```

### 中级开发者

```
1. 开发者接入指南 (掌握完整功能)
2. API 参考手册 (深入学习 API)
3. 项目架构文档 (了解后端设计)
```

### 高级开发者

```
1. 项目架构文档 (深度理解架构)
2. 部署文档 (掌握生产部署)
3. 源代码阅读 (参与开发)
```

---

## 📞 获取帮助

### 文档反馈

如果文档有错误或需要改进，请：
1. 提交 Issue
2. 发起 Pull Request

### 技术支持

- 查看 [常见问题](DEVELOPER_GUIDE.md#五常见问题)
- 阅读 [API 文档](http://localhost:9000/api/v1/docs)
- 提交 Issue 到项目仓库

---

**更新时间**: 2024-12-23