控制端点 /api/dsh/_gw/* 始终在线：查询状态、启停业务端点、修改 admin token
业务端点 /api/dsh/* 默认关闭，启用后提供任务提交、会话查询、用户/工作区管理、记忆读写
多用户 / 多工作区隔离：每 (用户 × 工作区) 一个持久 Agent 会话，互不干扰
鉴权：控制端点用 admin token，业务端点用用户 apiKey（x-api-key 或 Authorization: Bearer）
持久化：状态保存在 $DSH_HOME/.dsh-api/（users.json / workspaces.json / gateway-config.json）
Client UI：左下角图标 + 设置页，可查看状态、开关服务、配置 token

安装

要求：已安装 DSH（桌面版默认 profile 为 web），DSH 桌面版或 CLI 均可。

从 npm 安装（推荐）

dsh plugin --profile web add dsh-api-gateway

指定版本：

dsh plugin --profile web add dsh-api-gateway@23.0.1

从 GitHub 安装

dsh plugin --profile web add github:zuoxiang20/dsh-api-gateway
# 或
dsh plugin --profile web add git+https://github.com/zuoxiang20/dsh-api-gateway.git

安装成功后重启 DSH 生效（Bundle 在启动时加载），插件会自动进入 profile 的 dsh.profile.bundles。

使用

重启 DSH 后，点击左下角图标或进入设置页
点击「启用」开启业务端点
首次使用的默认 admin token 为 dsh-admin-2024，建议立即在设置页修改

接口列表

完整接口文档（含请求/响应示例、鉴权说明、curl 对接示例）：👉 docs/api.md

端点速览：

方法	路径	鉴权	说明
GET	`/api/dsh/_gw/status`	无	查询状态
POST	`/api/dsh/_gw/toggle`	admin	启用/停用业务端点
POST	`/api/dsh/_gw/setToken`	admin	修改 admin token
POST	`/api/dsh/users`	admin	创建用户（返回 apiKey）
POST	`/api/dsh/workspaces`	admin	创建工作区
POST	`/api/dsh/task`	user	提交任务
GET	`/api/dsh/task/:id`	user	查询任务结果
GET/DELETE	`/api/dsh/memory?workspace=<id>`	user	读写记忆

卸载

dsh plugin --profile web remove dsh-api-gateway

开发

目录结构

.
├── package.json        # 包元数据 + dsh.bundle + dsh.client 声明
├── host.js             # Host 端：控制端点 + 业务逻辑（Node ESM）
├── client.js           # Client 端：图标 + 设置页（__ModuleLoader__.load）
├── cordis.patch.yml    # Bundle 自插入：- insert: [{id, name}]
└── docs/api.md         # 完整接口文档

本地开发（直接引用源码目录，改代码后需重装同步）

# 把 <插件源码目录> 换成你本地的插件目录绝对路径
dsh plugin --profile web add "file:<插件源码目录>"
# 改完源码后，重装以同步快照
dsh plugin --profile web remove dsh-api-gateway
dsh plugin --profile web add "file:<插件源码目录>"

说明：file: 依赖是快照拷贝，改源码后必须 remove + add 重新同步，否则运行的还是旧版；每次操作后重启 DSH 生效。

发布流程

# 1. 改代码
# 2. 升版本并发布 npm
npm version patch
npm publish --registry https://registry.npmjs.org
# 3. 推送 GitHub
git add .
git commit -m "describe change"
git push