# Jointo - 后端需求文档总览 > **技术栈**:Python + PostgreSQL > **项目名称**:jointo > **项目域名**:https://www.jointo.ai > **文档版本**:v1.1 > **最后更新**:2025-01-27 --- ## 📚 文档导航 本目录包含Jointo项目的完整后端技术需求文档,按功能模块和技术层次组织。 ### 核心架构文档 | 文档 | 说明 | 状态 | | ------------------------------------------------------------ | -------------------------------- | ---- | | [01-architecture-overview.md](./01-architecture-overview.md) | 架构概述、设计原则、整体架构图 | ✅ | | [02-tech-stack.md](./02-tech-stack.md) | 技术栈选型、框架版本、工具库 | ✅ | | [03-system-design.md](./03-system-design.md) | 系统架构设计、分层架构、目录结构 | ✅ | ### 核心服务设计 #### 用户模块 (user/) | 文档 | 说明 | 状态 | | ---------------------------------------------------------------------------- | ------------------ | ---- | | [04-services/user/user-service.md](./04-services/user/user-service.md) | 用户管理服务 | ✅ | | [04-services/user/credit-service.md](./04-services/user/credit-service.md) | 积分管理服务 | ✅ | | [04-services/user/payment-service.md](./04-services/user/payment-service.md) | 支付服务 | ✅ | | [04-services/user/recharge-service.md](./04-services/user/recharge-service.md) | 充值服务 | ✅ | | [04-services/user/sms-service.md](./04-services/user/sms-service.md) | 短信服务 | ✅ | | [04-services/user/wechat-service.md](./04-services/user/wechat-service.md) | 微信登录服务 | ✅ | #### 项目管理模块 (project/) | 文档 | 说明 | 状态 | | ------------------------------------------------------------------------------------------------ | ------------------ | ---- | | [04-services/project/folder-service.md](./04-services/project/folder-service.md) | 文件夹管理服务 | ✅ | | [04-services/project/project-service.md](./04-services/project/project-service.md) | 项目管理服务 | ✅ | | [04-services/project/screenplay-service.md](./04-services/project/screenplay-service.md) | 剧本管理服务 | ✅ | | [04-services/project/screenplay-tag-service.md](./04-services/project/screenplay-tag-service.md) | 剧本标签服务 | ✅ | | [04-services/project/storyboard-service.md](./04-services/project/storyboard-service.md) | 分镜管理服务 | ✅ | | [04-services/project/storyboard-resource-service.md](./04-services/project/storyboard-resource-service.md) | 分镜资源关联服务 | ✅ | | [04-services/project/project-resource-service.md](./04-services/project/project-resource-service.md) | 项目资源关联服务 | ✅ | | [04-services/project/storyboard-board-service.md](./04-services/project/storyboard-board-service.md) | 分镜看板管理服务 | ✅ | | [04-services/project/comment-service.md](./04-services/project/comment-service.md) | 评论协作服务 | ✅ | | [04-services/project/export-service.md](./04-services/project/export-service.md) | 视频导出服务 | ✅ | #### 资源管理模块 (resource/) | 文档 | 说明 | 状态 | | ------------------------------------------------------------------------------------------------ | ------------------ | ---- | | [04-services/resource/attachment-service.md](./04-services/resource/attachment-service.md) | 附件管理服务 | ✅ | | [04-services/resource/file-storage-service.md](./04-services/resource/file-storage-service.md) | 文件存储服务 | ✅ | | [04-services/resource/project-resource-service.md](./04-services/resource/project-resource-service.md) | 项目资源服务 | ✅ | #### AI 模块 (ai/) | 文档 | 说明 | 状态 | | ------------------------------------------------------------------------ | -------------- | ---- | | [04-services/ai/ai-service.md](./04-services/ai/ai-service.md) | AI 生成服务 | ✅ | | [04-services/ai/video-service.md](./04-services/ai/video-service.md) | 视频管理服务 | ✅ | ### 基础设施文档 | 文档 | 说明 | 状态 | | ---------------------------------------------- | ------------------------ | ---- | | [07-async-tasks.md](./07-async-tasks.md) | 异步任务处理(Celery) | ✅ | | [08-storage.md](./08-storage.md) | 文件存储方案(MinIO/S3) | ✅ | | [09-ai-integration.md](./09-ai-integration.md) | AI 服务集成 | ✅ | | [10-deployment.md](./10-deployment.md) | 部署架构(Docker/K8s) | ✅ | | [11-performance.md](./11-performance.md) | 性能优化策略 | ✅ | | [12-security.md](./12-security.md) | 安全设计 | ✅ | --- ## 🚀 快速开始 ### 1. 了解整体架构 从 [架构概述](./01-architecture-overview.md) 开始,了解系统的核心特点和设计原则。 ### 2. 选择技术栈 查看 [技术栈选型](./02-tech-stack.md),了解使用的框架和工具。 ### 3. 深入系统设计 阅读 [系统架构设计](./03-system-design.md),理解分层架构和项目结构。 ### 4. 核心服务实现 按需查看 `04-services/` 目录下的各个服务设计文档。 --- ## 📋 技术栈概览 | 类别 | 技术选型 | | -------- | ----------------------- | | Web 框架 | FastAPI 0.104+ | | ORM | SQLModel 0.0.14+ | | 数据库 | PostgreSQL 14+ | | 缓存 | Redis 7+ | | 任务队列 | Celery 5.3+ + RabbitMQ | | 文件存储 | MinIO / AWS S3 | | 视频处理 | FFmpeg | | 认证 | JWT | | 容器化 | Docker + Docker Compose | --- ## 🏗️ 系统架构图 ``` ┌─────────────────────────────────────────────────────────────┐ │ 前端 (React) │ └───────────────────────────┬─────────────────────────────────┘ │ HTTPS ┌───────────────────────────▼─────────────────────────────────┐ │ API Gateway / Nginx │ └───────────────┬───────────────────────────┬─────────────────┘ │ │ ┌───────────▼──────────┐ ┌───────────▼──────────┐ │ API 服务 (FastAPI) │ │ WebSocket 服务 │ └───────────┬──────────┘ └──────────────────────┘ │ ┌───────────▼───────────────────────────────────────────┐ │ 业务逻辑层 (Services) │ └───────────┬───────────────────────────────────────────┘ │ ┌───────────▼───────────────────────────────────────────┐ │ 数据访问层 (Repositories) │ └───────────┬───────────────────────────────────────────┘ │ ┌───────────▼───────────────────────────────────────────┐ │ 基础设施层 (PostgreSQL/Redis/MinIO) │ └────────────────────────────────────────────────────────┘ ``` --- ## 📝 文档维护 - 每个文档应保持独立性,避免过度依赖其他文档 - 文档间通过相对链接关联 - 代码示例应保持最新,与实际实现同步 - 重大变更需更新相关文档的版本号和更新日期 ### 变更记录 **v1.2 (2025-01-27)** - 技术栈调整:将 ORM 从 SQLAlchemy 2.0 升级为 SQLModel 0.0.14+ - 原因:更好的类型安全、减少重复代码、与 FastAPI 完美集成 **v1.3 (2025-01-27)** - 重构服务文档结构,按模块分组: - 用户模块 (6个服务):用户、积分、支付、充值、短信、微信 - 项目管理模块 (10个服务):文件夹、项目、剧本、标签、分镜、资源关联、分镜看板、评论、导出 - 资源管理模块 (3个服务):附件、文件存储、项目资源 - AI 模块 (2个服务):AI生成、视频管理 - 补充缺失的服务文档链接 **v1.1 (2025-01-27)** - 新增 5 个核心服务文档: - user-service.md - 用户管理服务(注册、登录、订阅、积分) - resource-service.md - 资源管理服务(角色、场景、道具) - video-service.md - 视频管理服务(AI生成、上传、状态跟踪) - storyboard-board-service.md - 分镜看板管理服务(轨道、项、时间范围查询) - comment-service.md - 评论协作服务(多态评论、回复、@提及) - 调整服务列表顺序,按业务逻辑分组 **v1.0 (2025-01-27)** - 初始版本 - 完成核心架构文档 - 完成基础服务文档(文件夹、项目、剧本、附件、分镜、AI、导出) --- ## 🔗 相关文档 - [前端技术文档](../frontend/README.md) - [API 文档](http://localhost:8000/api/docs)(开发环境) --- **维护者**:后端开发团队 **联系方式**:dev@jointo.ai