Files
xiaoxia-saas/CHANGELOG.md
T
Xiaoxia AI 04cfa5e7a8
Deploy / Deploy Staging (push) Failing after 7s
Deploy / Deploy Production (push) Has been skipped
Tests / test (push) Failing after 32s
Tests / lint (push) Failing after 29s
docs: add comprehensive API usage guide and changelog
- Create detailed API usage guide with examples
- Cover all 19 API endpoints with request/response samples
- Add authentication flow documentation
- Include error handling and best practices
- Add rate limiting and token management guide
- Create CHANGELOG.md tracking all Phase 4 changes

Phase 4 Task 34/68 completed
2026-06-17 08:17:16 +08:00

2.6 KiB
Raw Blame History

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.0.0] - 2026-06-17

Phase 4: SAAS 产品化 - 完成

Added

认证系统:

  • 用户注册(邮箱验证)
  • 用户登录(JWT + Session
  • 用户登出(单设备/所有设备)
  • 邮箱验证
  • 密码重置(邮件重置链接)
  • JWT Serviceaccess + refresh token
  • 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
  • WorkspaceMemberRepositoryInMemory
  • WorkspaceInvitationRepositoryInMemory

API 层:

  • FastAPI 应用主入口
  • 依赖注入容器
  • 认证中间件(JWT 验证)
  • 权限中间件
  • 全局异常处理
  • 请求日志中间件
  • 速率限制中间件
  • CORS 配置
  • 6 个认证接口
  • 13 个工作空间接口

数据库:

  • PostgreSQL 表结构设计
  • 初始化迁移脚本
  • 索引优化
  • 外键约束

部署:

  • Dockerfile
  • docker-compose.yml
  • 环境变量配置
  • 部署文档

文档:

  • README(快速开始)
  • API 使用指南
  • 数据库迁移指南
  • Docker 部署指南
  • Phase 4 设计文档
  • Phase 4 完成总结

Changed

  • N/A (首次发布)

Deprecated

  • N/A

Removed

  • N/A

Fixed

  • N/A

Security

  • bcrypt 密码加密(cost=12
  • JWT token 签名验证
  • SQL 注入防护(参数化查询)
  • CORS 安全配置
  • 速率限制(防止暴力破解)

[0.1.0] - 2026-06-16

Phase 1-3: 基础功能

  • 基础视频处理功能
  • 素材库管理
  • 项目管理

说明:

  • [Added] 新增功能
  • [Changed] 功能变更
  • [Deprecated] 即将废弃的功能
  • [Removed] 已删除的功能
  • [Fixed] Bug 修复
  • [Security] 安全相关更新