dsh-api-client
beatther-c/dsh-api-client
DeepSeek Harness용 에이전트 네이티브 API 클라이언트입니다. 컨텍스트 메뉴와 전체 키보드 탐색이 가능한 요청 트리, 크기 조절 사이드바, 항목별 억제와 비밀값 상시 마스킹을 지원하는 계층형 자동 헤더 미리보기의 Postman 스타일 디버깅 UI를 제공합니다. 공통 요청 코어를 공유하는 `api_client_*` 에이전트 도구 6개, UI와 공유하는 비식별화·감사 체인, 마이그레이션 보고서가 포함된 Postman Collection v2.1 가져오기, SecretRef 간접 참조 환경 변수, fail-closed SSRF 네트워크 정책을 포함합니다.
설치
dsh plugin --profile web add github:beatther-c/dsh-api-clientREADME
dsh-api-client
API Client for DeepSeek Harness
Postman-like API testing UI + Agent-native HTTP tools + Postman Collection import
Human UI 与 Agent Tools 共用同一套 API Client Core 的 DSH 原生插件。
特性
- Postman 级调试体验:Collection / Folder / Request 三级树、Request Tabs、7 种 HTTP 方法、Params/Headers/Auth/Body 编辑器、JSON Editor、Response Viewer(Pretty/Raw/Preview)
- Agent 原生工具:
api_client_request/api_client_run_request/api_client_list_collections/api_client_list_requests/api_client_get_request/api_client_get_last_response——Agent 与 Human 共用同一 HTTP Executor 与审计体系,高风险方法自动进入 Approval - Postman Collection v2.1 导入:兼容性扫描 + Migration Report,脚本只警告不执行,部分不兼容不阻断导入
- Environment 与密钥安全:
shared/secrets/(0700/0600)+ SecretRef 引用分工,History 与 Agent Context 全链路脱敏,History 永不持久化密钥明文 - SSRF 网络策略:默认 fail-closed(拒 localhost/私网)、blocked hosts/ports、redirect 逐跳重评估、DNS rebinding 防护
- DSH 原生集成:官方 Slot 优先 + DOM fallback 双路径 UI 适配(feature-detect,不按版本嗅探)、Settings 配置页、主题跟随、热插拔无需重启
安装
需要 DeepSeek Harness >=0.1.2-rc.1。
# 从 npm 安装(发布后)
dsh plugin --profile web add dsh-api-client
# 本地源码安装(开发/试用)
git clone https://github.com/Beatther-c/dsh-api-client.git
cd dsh-api-client && pnpm install && pnpm build
dsh plugin --profile web add link:$PWD
安装后 DSH Sidebar「New Session」下方出现 API Client 入口。
使用
- Human:点击 Sidebar 入口进入主视图——新建/导入 Collection,编辑请求,Send,查看 Response 与 History;Environment 管理变量与 secret(UI 恒脱敏显示);Settings → Plugins → API Client 调整超时/网络策略/权限
- Agent:在 DSH 会话中直接让 Agent 调用
api_client_*工具,或在 API Client 中点击「交给 Agent」把脱敏后的调试上下文送入新会话
文档
| 文件 | 内容 |
|---|---|
| docs/DESIGN_V1.1.md | 完整设计方案 V1.1(技术决策 D1–D26 冻结) |
| docs/V01_IMPLEMENTATION_DESIGN.md | V0.1 可执行实现设计(WP0–WP8 / AC-01…43 / TC×127) |
| docs/M0_SPIKE_DESIGN.md + docs/M0_SPIKE_REPORT.md | DSH 兼容性验证设计与实测报告(17 项) |
| docs/DSH_COMPATIBILITY_MATRIX.md | DSH 能力兼容矩阵(against 0.1.2-rc.1) |
| docs/UI_ADAPTER_CONTRACT.md / docs/CLIENT_MANIFEST_CONTRACT.md | UI 适配与插件 manifest 冻结契约 |
| docs/V01_MANUAL_VERIFICATION.md | V0.1 手工运行时验证记录(含证据截图) |
| docs/REVIEW_NOTES_V1.1.md | 二轮评审待办与决策记录 |
开发
pnpm install
pnpm build # tsup 双入口:dist/index.js(host) + dist/client.js(client)
pnpm test # vitest:19 spec / 209 tests
架构:packages/core|shared|postman-adapter(纯 TS,零 DSH import)+ src/host(Host API 28 端点 + 服务 + Agent 工具)+ src/client(dsh-adapter 双路径 + 视图/组件)。所有 DSH UI 内部契约只允许出现在 dsh-adapter/ 与极薄 slot 注册层。
开发规范
智能体工作规范见 AGENTS.md;项目硬规范(红线/门禁/环境/决策)见 PROJECT.md;变更记录见 CHANGELOG.md 与 docs/DEVLOG.md;经验沉淀见 knowledge-base/。
Roadmap
- V0.1:完整 API Client + Agent 工具 + Postman 导入 + 安全体系 + 兼容矩阵
- V0.2(当前,npm 0.2.0):常用交互优化 P0——请求树桌面交互(右键菜单/键盘契约/行内重命名)、可调侧栏(三态+drawer+持久化)、自动生成 Header/Query 分层(canonical buildRequestPlan/停用/恒脱敏)、Folder CRUD 与跨集合复制剪切移动(Host 剪贴板+乐观锁)、删除强确认与 tab 一致性
- V0.3:OpenAPI / curl / HAR 导入、Collection Runner、Workbench Embedded Surface Spike、基线文案中文化收尾(R-09)、tab identity 统一、可恢复删除(Undo)
- V0.4+:OAuth2、Scripts Sandbox、Tests、Advanced Secret Providers
- V1.0:GraphQL / WebSocket / gRPC / Mock、插件市场稳定发布、多 profile 兼容