文档
开发文档

仓库与代码结构

new-api 基线导入、目标目录与审计删减约定

基线导入

2026-10-02 platform/oceanway-platform 已在验证分支 t01-baseline-environment 导入官方 new-api rc.41,完整 SHA 为 2035a82aeb5414253a728bd937d4b8f97aa99b9b;保留本地入口和上游许可证材料,详见平台 docs/baseline.md。阶段 1 使用此隔离基线开展审计与闭环验证;阶段 2 将已验证基线及必要扩展纳入正式平台。避免在已有文档目录上执行覆盖式 clone;先建立临时目录、核对来源,再合入本地入口。

导入时记录官方仓库 URL、标签、完整 SHA、导入时间、许可证/NOTICE、工具链和依赖锁文件;实际源码与版本必须一致。文档中的历史标签、references/new-api 或 uumi 分支不能冒充新基线。保留上游版权与许可证材料,对外源码供给安排按项目许可要求处理。

目标结构

以下是建设目标,按所选基线真实目录调整,不表示目前存在代码。

platform/oceanway-platform/
├─ README.md                 实际启动与文档链接
├─ AGENTS.md                 本仓开发约束
├─ main.go                   沿用基线应用入口
├─ router/                   公共 API、内部产品接口和管理路由
├─ middleware/               会话、Key、CSRF、角色和产品授权
├─ controller/               请求/响应,不直接改余额
├─ service/                  身份、定价、记账、支付与恢复
├─ model/                    基线模型及平台扩展
├─ relay/                    协议及两个上游的接入
├─ ...                       基线实际需要的其他包
├─ migrations/               可审计数据库变更(建议新增)
├─ web/
│  ├─ console/               现有 Console React 前端迁入
│  ├─ admin/                 现有 Admin React 前端迁入
│  └─ shared/                确有复用价值的客户端/组件(按需)
├─ docs/
│  ├─ README.md              唯一产品/开发文档入口
│  ├─ baseline.md            基线 SHA 与代码审计事实
│  ├─ openapi/               自有接口契约及兼容性说明
│  └─ verification/          脱敏证据索引
├─ testdata/                 协议、支付和故障夹具
├─ scripts/                  从干净检出运行的检查/构建脚本
└─ deploy/                   应用配置模板和构建说明

服务命名、嵌入静态资源目录、迁移框架以及前端工作区形式在基线审计后记录到 docs/baseline.md。部署编排仍以 Infrastructure 为源;平台 deploy/ 不复制第二套生产编排。

审计删减

先给每项列出调用点、路由、中间件、用量解析、资金/Key 额度、测试与迁移影响,再决定保留/删除。优先保留可运行基线完成验证,不先批量删除适配器。替换旧 web/ 前确认两套前端可构建、资源路径和 API 路由互不遮盖。

OAuth、任务、价格和角色的既有代码均需按所选 SHA 验证。删除列表见new-api 基线,审计结果应能指出真实路径和测试结果。

本仓文档边界

仓库 README 写“实际如何运行”;docs/baseline.md 写“实际导入了什么”;OpenAPI 写“实际承诺的接口”;验证索引写“实际跑了什么”。PRD、架构方案、计划和进度不在本仓重写。自动生成文件从生成命令更新,密钥、支付凭证和生产导出不入 Git。

On this page