Files
tiku-backend.net/docs

TIKU Backend 文档

这里仅记录当前代码已经实现的架构、运行方式和维护约束。接口细节以 Development 环境的 OpenAPI/Scalar 为准,数据库结构以 EF Core Migration 和模型快照为准。

从这里开始

目标 文档
首次拉取代码,启动本地开发环境 本地开发快速上手
从空库验收租户创建、Owner 激活和站点发布 空数据库到租户建站验收
理解项目分层、运行时和业务边界 系统架构与业务边界
按模块协作、拆分 Service 或调整依赖 模块边界与所有权
修改认证、权限或租户数据 认证、授权与租户隔离
查看 Tiku/RuoYi 双线取舍和公平基准边界 双线能力矩阵
部署 API/Worker、配置依赖或排查任务 配置与后台任务

文档边界

  • README.md:项目定位、最短启动入口和仓库地图。
  • docs/quickstart.md:非破坏性的日常开发路径。
  • docs/tenant-provisioning.md:会创建或清理本地数据库的完整 SaaS 验收路径。
  • docs/architecture/**:当前代码的稳定设计与安全边界。
  • docs/operations.md:部署配置、后台处理、健康检查和恢复演练。

路线图、阶段计划、代码评审快照和历史迁移过程不放在当前实现文档中;需要保留时应进入 Issue、项目管理系统或明确标记的历史归档。

权威来源

  • API 契约:Tiku.Api/Controllers、请求/响应 DTO 和运行时 OpenAPI。
  • 数据模型:Tiku.DomainTiku.Infrastructure/Persistence/Configurations 和 EF Core Migration。
  • 认证授权:Tiku.Api/ConfigurationTiku.Api/MiddlewareTiku.Application/SecurityTiku.Infrastructure/Security
  • 后台任务:Tiku.WorkerTiku.Application/JobsTiku.Infrastructure/Jobs
  • 外部服务Application 接口与 Infrastructure 实现;运行时租户配置存储在 TenantExternalProviderTenantSecret

维护规则

  1. 文档只描述当前可从代码或自动化测试确认的行为。
  2. 新增租户实体时,同时验证 Query Filter、租户唯一索引、组合外键和写入拦截器。
  3. 数据库结构变更必须生成 EF Core Migration并检查 migration script 和 pending model changes。
  4. 不在文档中保存连接密码、JWT 私钥、证书密码、Provider 密钥或平台管理员临时密码。
  5. 代码行为变化时更新对应主题,不新增内容重叠的临时说明文件。
  6. 不维护阶段路线图、旧后端接口对比、评审快照或开发过程记录。