forked from xiongyuxing/tiku-backend.net
2.0 KiB
2.0 KiB
TIKU Backend 文档
这里仅记录当前代码已经实现的架构、运行方式和维护约束。接口细节以 Development 环境的 OpenAPI/Scalar 为准，数据库结构以 EF Core Migration 和模型快照为准。
阅读入口
| 文档 | 内容 | 适合谁 |
|---|---|---|
| 本地开发与运行 | PostgreSQL 初始化、启动 API、验证命令、常见问题 | 新开发者 |
| 系统架构与业务边界 | 项目依赖、运行时组件、当前业务模块和后台任务链路 | 开发与评审人员 |
| 认证、授权与租户隔离 | 登录、Session、JWT、Cookie/CSRF、Realm、RBAC、Capability、DataScope、租户隔离 | API 与安全开发者 |
| 配置与后台任务 | 环境配置、Production 启动门禁、Redis、Hosted Service、健康检查 | 开发与运维人员 |
权威来源
- API 契约：
Tiku.Api/Controllers、请求/响应 DTO 和运行时 OpenAPI。 - 数据模型：
Tiku.Domain、Tiku.Infrastructure/Persistence/Configurations和 EF Core Migration。 - 认证授权：
Tiku.Api/Configuration、Tiku.Api/Middleware、Tiku.Application/Security、Tiku.Infrastructure/Security。 - 后台任务：
Tiku.Api/BackgroundProcessing、Tiku.Application/Jobs和Tiku.Infrastructure/Jobs。 - 外部服务：Application 接口与 Infrastructure 实现；运行时租户配置存储在
TenantExternalProvider和TenantSecret。
维护规则
- 文档只描述当前可从代码或自动化测试确认的行为。
- 新增租户实体时，同时验证 Query Filter、租户唯一索引、组合外键和写入拦截器。
- 数据库结构变更必须生成 EF Core Migration，并检查 migration script 和 pending model changes。
- 不在文档中保存连接密码、JWT 私钥、证书密码、Provider 密钥或平台管理员临时密码。
- 不再维护阶段路线图、旧后端接口对比、评审快照或开发过程记录。