Files
xiaoxia-saas/CHANGELOG.md
T
API文档维护 5154395edb
CI/CD Pipeline / Validate Code Quality And Tests (pull_request) Has been cancelled
CI/CD Pipeline / Frontend Lint (pull_request) Has been cancelled
docs: API 参考文档 v0.1.88 + CHANGELOG 更新
- 新增 API 参考文档(v0.1.88),覆盖 17 个模块、50+ 端点
- 更新 CHANGELOG,记录 v0.1.77 ~ v0.1.88 的全部变更
- 重点更新:查重 API、订阅 API、标题库 API、配音库 API

变更内容:
- 认证 API:7 个端点
- 项目 API:3 个端点
- 任务中心 API:2 个端点
- 素材诊断 API:1 个端点
- 素材库 API:2 个端点
- 素材 API:3 个端点
- 导入/分类任务 API:4 个端点
- 上传 API:3 个端点
- 分片上传 API:4 个端点
- 生成任务 API:3 个端点
- 成片 API:4 个端点
- 标题库 API:5 个端点
- 配音库 API:5 个端点
- 查重 API:5 个端点
- 订阅 API:5 个端点
2026-06-29 10:53:32 +08:00

439 lines
8.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
## [v0.1.88] - 2026-06-29
### Phase 2 前端优化 - 完成 ✅
**前端交互全面优化:**
- 素材上传添加 project_id 参数
- Drager 组件显示上传列表
- 按钮防重复提交
- 前端交互状态反馈补充(P0 第一批)
---
## [v0.1.87] - 2026-06-29
### Bug 修复
- Docker compose 修复 mem_limit 冲突
---
## [v0.1.86] - 2026-06-29
### CI/CD 优化
- CI 优化
---
## [v0.1.85] - 2026-06-29
### CI/CD 优化
- CI 优化
---
## [v0.1.84] - 2026-06-29
### CI/CD 优化
- CI runner label 匹配修复
---
## [v0.1.83] - 2026-06-29
### CI/CD 优化
- CI SSH debug 修正
---
## [v0.1.82] - 2026-06-29
### CI/CD 优化
- CI SSH debug 修正
---
## [v0.1.81] - 2026-06-29
### CI/CD 优化
- CI runner label 匹配修复
---
## [v0.1.80] - 2026-06-28
### Bug 修复
- 修复 redirect_slashes + 标题字段匹配
---
## [v0.1.79] - 2026-06-28
### Deployment
- Re-trigger deployment
---
## [v0.1.78] - 2026-06-28
### Bug 修复
- 修复 500 错误
- CORS 配置修复
- redirect_slashes 禁用
---
## [v0.1.77] - 2026-06-28
### Bug 修复
- 修复标题库新建/编辑 — 前后端字段名不匹配导致 422
---
### Phase 2 功能合并(v0.1.77 ~ v0.1.88
**新增功能 PR:**
- PR#74: Phase 1 核心重构 — 标题库 API、配音库 API、去 Project 层清理
- PR#75: Phase 2 查重功能前端页面
- PR#76: Phase 2 查重功能后端 API(5 个端点)
- PR#77: Phase 2 订阅管理前端页面
- PR#78: Phase 2 订阅管理后端 API(5 个端点)
- PR#79: 修复一键生成页面废弃 API 调用
- PR#80: 回退域对象 extra_meta → metadata
- PR#81: 删除查重 API 错误的 204 返回
- PR#82: 查重上传接口错误信息不再泄露内部异常(安全审计)
- PR#83: 订阅 + 查重单元测试(63 用例)
- PR#84: 订阅管理前端对接真实 API
- PR#85: 禁用 redirect_slashes 修复 307 重定向
- PR#90: 标题库字段名修复
- PR#91: 标题/配音创建 500 修复 + CORS
- PR#94: 素材库新建自动获取默认 project_id
- PR#97: 前端交互状态反馈全面补充
---
- Docker compose 修复 mem_limit 冲突
---
## [v0.1.86] - 2026-06-29
### CI/CD 优化
- CI 优化
---
## [v0.1.85] - 2026-06-29
### CI/CD 优化
- CI 优化
---
## [v0.1.84] - 2026-06-29
### CI/CD 优化
- CI runner label 匹配修复
---
## [v0.1.83] - 2026-06-29
### CI/CD 优化
- CI SSH debug 修正
---
## [v0.1.82] - 2026-06-29
### CI/CD 优化
- CI SSH debug 修正
---
## [v0.1.81] - 2026-06-29
### CI/CD 优化
- CI runner label 匹配修复
---
## [v0.1.80] - 2026-06-28
### Bug 修复
- 修复 redirect_slashes + 标题字段匹配
---
## [v0.1.79] - 2026-06-28
### Deployment
- Re-trigger deployment
---
## [v0.1.78] - 2026-06-28
### Bug 修复
- 修复 500 错误
- CORS 配置修复
- redirect_slashes 禁用
---
## [v0.1.77] - 2026-06-28
### Bug 修复
- 修复标题库新建/编辑 — 前后端字段名不匹配导致 422
---
## [Unreleased]
#### Added
**素材管理:**
- 素材上传与存储(MinIO
- 素材列表与查询
- 素材标签管理
- 素材库管理
- 素材分类功能
**视频生成:**
- 生成任务创建
- Celery worker 自动触发
- 生成结果管理
- 生成进度查询
**成片下载:**
- 预签名下载 URL
- 规范化存储路径(workspace/project/task
- 下载链接有效期管理
**前端联调:**
- 生成页面(ProjectGeneration.tsx
- 结果页面(ProjectResults.tsx
- API 客户端(generation.ts
#### Fixed
**代码质量:**
- 清理所有 TODOsession_id in JWT, repository injection
- 修复 worker 中的 repository 注入
- 完善 JWT payload 包含 session_id
**文档:**
- 修复 README.md UTF-8 乱码问题
- 创建 API-MAINLINE.md68+ endpoints
- 创建 CODE-STATUS.md(代码状态标注)
- 更新 saas-index.md(现代导航结构)
### 专项工作
**专项 A: CI/CD 稳定性修复 - 完成 ✅**
- 修复质量检查工具链
- 统一 .gitea 和 .github workflows
- 建立 runner 基础设施治理
- CI 从不稳定收敛为可靠基础设施
**专项 B: 全仓主线路径澄清 - 完成 ✅**
- 创建 API 主线清单文档
- 标注所有代码状态(ACTIVE/COMPAT/DEPRECATED
- 测试分类清单
- 快速定位指南
---
## [1.0.0] - 2026-06-17
### Phase 4: SAAS 产品化 - 完成
**开发时长:** 5 小时 54 分钟
**完成进度:** 50/68 (73.5%)
**代码量:** 20,500+ 行
**测试覆盖:** 85%+
#### Added
**认证系统:**
- 用户注册(邮箱验证)
- 用户登录(JWT + Session
- 用户登出(单设备/所有设备)
- 邮箱验证
- 密码重置(邮件重置链接)
- JWT Serviceaccess + refresh token30分钟/30天)
- Password Hasherbcrypt, cost=12
- Session StoreRedis-based
- Email ServiceSMTP with templates
**工作空间管理:**
- 创建工作空间
- 获取工作空间列表/详情
- 邀请成员(邮件邀请)
- 接受/拒绝邀请
- 移除成员
- 离开工作空间
- 修改成员角色
- 获取成员列表
**权限系统:**
- 基于角色的访问控制(RBAC
- 4 种角色(Owner/Admin/Member/Viewer
- 细粒度权限定义
- 权限检查中间件
- 数据隔离
**订阅系统:**
- 3 级订阅计划(Free/Pro/Enterprise
- 升级订阅
- 取消订阅(降级到 Free
- 自动配额调整
**配额系统:**
- 项目数量限制检查
- 存储空间限制检查
- 配额使用状态查询
- 警告级别(normal/warning/critical/exceeded
- 存储使用量更新
**Repository 层:**
- UserRepositoryInMemory + PostgreSQL
- WorkspaceRepositoryInMemory + PostgreSQL
- WorkspaceMemberRepositoryInMemory + PostgreSQL
- WorkspaceInvitationRepositoryInMemory + PostgreSQL
- ProjectRepositoryInMemory + PostgreSQL
- 数据库连接池(ThreadedConnectionPool
- 连接池上下文管理器(PooledConnection
**API 层:**
- FastAPI 应用主入口
- 依赖注入容器
- 22 个 REST API 接口
- 6 个认证接口
- 13 个工作空间接口
- 3 个健康检查接口
- 认证中间件(JWT 验证)
- 权限中间件
- 全局异常处理
- 请求日志中间件
- 速率限制中间件
- 性能监控中间件
- API 版本管理中间件
- CORS 配置
**数据库:**
- PostgreSQL 表结构设计
- 初始化迁移脚本
- 索引优化
- 外键约束
- 配置切换(InMemory/PostgreSQL
**部署:**
- Dockerfile
- docker-compose.yml
- 环境变量配置
- 健康检查端点(/health, /ready, /startup
- Kubernetes 配置示例
**性能优化:**
- 数据库连接池(5-6x 性能提升)
- 慢请求监控(threshold: 1s
- 慢查询检测(threshold: 100ms
- 请求 ID 追踪
- 响应时间记录(X-Process-Time header
**文档:**
- README(快速开始)
- API 使用指南
- 数据库迁移指南
- Docker 部署指南
- 数据库切换指南
- 连接池性能指南
- 性能监控指南
- 环境配置指南
- API 版本管理指南
- 健康检查指南
- 分页使用指南
- 生产部署检查清单
- 贡献指南
- Phase 4 设计文档
- Phase 4 进度报告
- Phase 4 最终交付总结
**工具和功能:**
- 通用分页器(PaginationParams, PaginatedResponse
- 内存分页和数据库分页支持
#### Changed
- 所有 PostgreSQL Repository 使用连接池
- 优化数据库查询性能
- 改进错误响应格式(统一 JSON
#### Deprecated
- N/A
#### Removed
- N/A
#### Fixed
- 修复路由注册顺序
- 修复健康检查端点注册
#### Security
- bcrypt 密码加密(cost=12
- JWT token 签名验证
- SQL 注入防护(参数化查询)
- CORS 安全配置
- 速率限制(防止暴力破解)
- 敏感信息保护(.gitignore
#### Performance
- 数据库连接池:5-6x 性能提升
- API 响应时间:< 50ms(平均)
- 数据库查询:< 10ms(平均)
- 并发支持:1000+ RPS
---
## [0.1.0] - 2026-06-16
### Phase 1-3: 基础功能
- 基础视频处理功能
- 素材库管理
- 项目管理
---
**说明:**
- [Added] 新增功能
- [Changed] 功能变更
- [Deprecated] 即将废弃的功能
- [Removed] 已删除的功能
- [Fixed] Bug 修复
- [Security] 安全相关更新
- [Performance] 性能优化