website: generate the API reference from source (cordis + all 15 harness services)

scripts/gen-website-api.ts renders website/zh-CN/api/{cordis,harness}/* and the
api-sidebar.json fragment the VitePress config imports, so pages and navigation
can never drift from the code: signatures, @param/@returns prose, dispatch
modes, and GitHub source links are extracted, never transcribed, and the
generator hard-errors on any rendered member missing docs. verify-website-api
(doc-sync + run-gates) is the freshness gate.

Replaces the hand-written zh api pages (7 pages covering 7 of 15 services,
with phantom APIs: Context.current/Context.events, agent/post-step, tool/call,
compact/*, llm/pre-request none of which exist) with generated English
references: 5 cordis pages, 15 per-service pages, and a 35-event catalog
grouped by scope. The hand-written hub api/index.md stays and now indexes the
full surface; zh for these pages arrives with the unified translation flow.
This commit is contained in:
lintianle
2026-07-16 18:13:34 +08:00
parent da26138592
commit efba9fab0a
31 changed files with 2983 additions and 931 deletions

View File

@@ -1,25 +1,37 @@
# API 参考
本节提供 DeepSeek Harness 的完整 API 参考文档,分为两部分:
本节是 DeepSeek Harness 的 API 参考。除本页外,`cordis/` 与 `harness/` 下的所有页面**由脚本从源码生成**(`pnpm run gen-website-api`,CI 校验新鲜度),签名与说明永远与代码一致;生成页目前为英文,中文版将随统一翻译流程提供。
## 框架 API
Cordis 微内核提供的基础能力,所有插件开发都建立在这些 API 之上:
- [Context](./cordis/context) — 上下文对象,所有服务和方法的入口
- [Events](./cordis/events) — 事件系统 API(emit / on / bail / serial / waterfall)
- [Fiber](./cordis/fiber) — 作用域生命周期(状态机、effect、dispose)
- [Events](./cordis/events) — 事件系统 API(on / emit / bail / serial / waterfall)
- [Fiber](./cordis/fiber) — 插件生命周期(状态机、effect、dispose)
- [Registry](./cordis/registry) — 插件注册(plugin / inject)
- [Service](./cordis/service) — 服务基类
## Harness API
DeepSeek Harness SDK 提供的扩展 API,用于构建 Agent 能力:
每个 `ctx.*` 服务一页,按服务名索引:
- [Tools (dsh-tools)](./harness/tools) — Tool 注册、defineTool DSL、Schema 类型系统
- [LLM (dsh-llm)](./harness/llm) — LLM 服务、适配器注册、StreamChunk 协议
- [Session (dsh-session)](./harness/session) — 会话事件流、消息类型
- [Agent (dsh-agent)](./harness/agent) — Agent 实例管理、生命周期
- [Bash (dsh-bash)](./harness/bash) — Bash 执行接口
- [Filesystem (dsh-fs)](./harness/fs) — 文件系统接口
- [Subagent (dsh-subagent)](./harness/subagent) — 子代理委派接口
- [ctx.agentLoop](./harness/agent-loop) — ReAct 循环的创建与恢复
- [ctx.agents](./harness/agents) — Agent 注册表与工厂
- [ctx.bash](./harness/bash) — Bash 执行接口(抽象缝)
- [ctx.codeRuntime](./harness/code-runtime) — 代码执行接口(抽象缝)
- [ctx.compact](./harness/compact) — 上下文压缩接口(抽象缝)
- [ctx.fs](./harness/fs) — 文件系统接口(抽象缝)
- [ctx.llm](./harness/llm) — LLM 服务与适配器注册
- [ctx.sessionPersistence](./harness/session-persistence) — 会话持久化接口(抽象缝)
- [ctx.sessions](./harness/sessions) — 会话存储
- [ctx.subagents](./harness/subagents) — 子代理委派
- [ctx.systemPrompt](./harness/system-prompt) — 系统提示词组装
- [ctx.tools](./harness/tools) — Tool 注册表
- [ctx.userInteraction](./harness/user-interaction) — 用户交互接口
- [ctx.web](./harness/web) — Web 搜索与抓取
- [ctx.workflows](./harness/workflows) — 动态工作流引擎(抽象缝)
事件总表:[Harness events](./harness/events) — 全部事件按作用域分组,含触发模式与载荷签名。
想学"怎么写一个 tool / 插件"?教程在[开发指南](../develop/basic/);本节只做精确的接口参考。