jianf/ModelRouter
1
0
Fork 0
mirror of https://gitcode.com/JianFeeeee/ModelRouter.git synced 2026-11-07 09:47:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
v3.0.0
ModelRouter/docs/development.md
JianFeeeee f7e926ccb7 docs: README 拆分为主题文档 + 中性化竞品表述 
README 从 642 行降到 131 行，只保留简介、核心能力、最小快速开始、文档索引、
改名说明、目录结构与测试入口。其余内容迁到 docs/，中英文索引一一对应：

  docs/features.md       实现与完整特性清单（原 README 的"实现/特性"）
  docs/configuration.md  配置文件、自动探测模型、多密钥与配额
  docs/routing.md        模型路由、AUTO 链、冷却与半冷却、源/适配器、源模板
  docs/performance.md    实测内存占用与调优、thinking 预算
  docs/webui.md          WebUI 使用
  docs/adapters.md       Lua 适配器协议与内置适配器清单
  docs/gui.md            桌面端 Headless/Desktop 两种产物与构建
  docs/development.md    目录职责、开发协作、测试
  docs/deployment.md     部署、发行包、目录权限、llmsproxy 迁移与验证清单

中性化：README / README_EN / GUI 注释里的 `Clash Verge` 类比全部改为
「桌面壳 / desktop shell」，仓库内（源码与文档）已无该表述。
2026-10-26 22:28:24 +08:00

1.3 KiB
Raw Permalink Blame History

开发与目录结构

本文档由 README 拆分而来：目录职责、开发协作、测试。 返回 README。

目录

cmd/modelrouter            # 入口（纯 Go 服务端）
cmd/gui                  # Electron 桌面 GUI（内嵌核心 + 托盘 + 打包）
internal/config          # YAML 配置加载/校验
internal/lua             # LuaJIT VM + worker 池 + AdapterCache + 内置适配器 (embed)
internal/provider        # Provider(HTTP) + Registry(路由)
internal/gateway         # OpenAI 兼容 HTTP 服务 + 鉴权 + SDK/流式 + WebUI
internal/types           # 统一格式 & OpenAI wire 类型

开发协作

  • Git 分支工作流：主分支 / 特性分支 / 发布分支的规范见 docs/git-workflow.md（English）。 主线：main 永可部署 → 特性合入 main → 切 release/vX.Y.Z 打 tag 发布 → hotfix 提交发布分支并 cherry-pick 回 main。
  • Lua 适配器协议：见 docs/lua-adapters.md （English）。

测试

go test -tags luajit ./...

覆盖：配置校验、适配器加载/变换、签名钩子、Gateway 鉴权、SDK 结算、SSE 流式、 模型路由、多模态透传与 thinking 预算。