AsterDrive 开发者文档
这里是面向 AsterDrive 贡献者、集成开发者和维护者的源码级文档库,覆盖仓库架构、领域设计、API、协议契约、测试基础设施和诊断入口。普通用户、部署者和管理员应优先阅读用户文档。
| 你的目标 | 建议入口 |
|---|---|
| 第一次接触仓库,想建立整体心智模型 | 架构概览 → 关键模块设计 |
| 开始开发任务,先确认长期边界和完成标准 | 项目契约 → 工程工作流 |
| 想快速定位代码入口、相关文档和最低验证 | 开发任务路由 |
| 判断一段后端逻辑应该放在哪一层 | 后端服务所有权边界 |
| 查找 REST、WebDAV、WOPI 或内部协议 | API 概览 |
| 修改存储、上传或远端节点链路 | 领域设计与契约 |
| 运行数据库、WebDAV 或诊断测试 | 测试与诊断 |
| 查阅尚未落地的讨论或历史决策背景 | 草稿与历史记录 |
| 准备修改用户文档或本站的写法规则 | 文档贡献指南 |
- 架构概览:节点模式、分层、启动链路、配置和数据流。
- 项目契约:产品身份、Forge 边界、数据与协议不变量和完成标准。
- 关键模块设计:文件、上传、任务、存储和协议模块的内部形状。
- 后端服务所有权边界:route、service、domain、repository、storage 和 protocol 的职责边界。
领域设计与契约
Section titled “领域设计与契约”- 领域设计与契约索引
- 外部认证模块
- 远端存储目标与策略归属
- 存储 descriptor 与字段规范化契约
- 对象命名与 OneDrive 直接下载
- 对象存储自定义认证与 AWS SDK 复用边界
- 上传完成契约矩阵
API 与协议
Section titled “API 与协议”API 概览按身份认证、文件工作流、团队与分享、后台任务、管理接口、WebDAV、WOPI、健康检查和 follower 内部协议组织全部接口页。机器可读规范仍以 OpenAPI 导出为准。
草稿与历史记录
Section titled “草稿与历史记录”- 草稿与历史记录索引
- 静态配置密钥处理备忘 — 草稿
- 服务层模块化重构历史方案 — 历史快照
- 工程工作流:从固定任务边界、读取最小上下文到分批验证和交付。
- 开发任务路由:按任务类型定位代码入口、权威文档和最低验证。
- 文档贡献指南:用户文档和开发者文档的分层归属、写法规则、中英同步策略和验证命令。
| 状态 | 含义 |
|---|---|
| 当前实现 | 默认状态;应与当前代码、路由和测试保持一致 |
| 草稿 | 记录待讨论方向,不代表已经接受或落地 |
| 历史快照 | 保留决策背景;正文中的旧名称和路径不作为当前实现依据 |
| 待翻译 | 中文内容可用,英文站暂时通过 Starlight fallback 展示中文原文 |
修改实现时,先以当前代码和测试确认事实,再同步对应文档。不要因为旧文档写过某个结构,就把已经迁移掉的路径重新引回来。