docs: 插件 SDK 文档站(API 参考从源码生成 + 自建检索)

为插件作者建一个文档站,重点是**能按描述搜到 API**,以及**明确能力边界**。

## 为什么 API 参考要生成而不是手写

公开 API 面有 115 个符号、11 个接口。手抄必然与代码漂移——这是文档站最常见的
死法(本仓 README 里已经有过几处「文档说一套、代码是另一套」)。

所以 `tools/apidoc` 直接从 `sdk/*.go` 提取签名、文档注释与代码块示例,渲染成
`docs/api/*.md`。发现文档不对时改的是**源码注释**,不是生成物。生成页首行带
「勿手改」标记,防止有人改了下次构建白改。

- `extract.go`:go/ast + go/doc 提取(只用标准库,离线可跑,不引入依赖)
- `gensite/`:渲染 Markdown + 检索索引
- `gensite/usages.go`:从 `example/` 21 个示例插件里反查**真实调用点**,
  贴在每个 API 下(源码注释里几乎没有可运行示例,但示例插件都是能编译跑的真代码)

## 能力边界:写这个站时查出的三处文档错误

这是本次最有价值的部分。原以为「公开 SDK 里有的 API 外部插件都能用」,
实测对照桥接模板后发现三处不符,站内已更正:

1. **`PluginMgr()` 被写成「仅内置可用」——错的。** 桥接模板第 692 行显式
   `base.SetPluginMgrAPI(procPluginMgr{})`,公开 `PluginMgrAPI` 注释也写「外部插件可调用」。
   真正的区别是**方法数**:公开面 3 个(ReloadOne/ListLoadedPlugins/IsPluginDisabled),
   内部面 9 个。容易混淆是因为两个包里有同名但不同的接口。
2. **`Events()` 外部插件恒为 nil。** `SetEventSubscriber` 全仓只有定义、无调用点,
   故 subscriber 从未被注入。外部插件的事件订阅实际由生成的运行时走
   `events.subscribe` RPC 完成——旧文档把它当成可用入口,会让人写出必然失效的代码。
3. **`UnregisterOutputChannel` 是静默无效,不是报错。** 桥接只注入 registrar、
   不注入 unregistrar,于是 `regOutputUnreg == nil`,函数命中 else 分支**直接返回 nil**
   (sdk/plugin.go:539-549)——不报错、通道也没注销。

每条裁定的依据写进 `tools/apidoc/tiers.json`(文件:行号 或 grep 结论),
站上以告警框呈现,读者可自行核对。判断依据三源:桥接模板的 `base.Set*` 注入点、
`internal/sdk` 完整面、`internal/plugin/proc/protocol.go` 的 RPC 表。

## 检索(用户的核心诉求)

两套互补:

- **MkDocs 内置搜索**:全文,中文走 jieba 分词。
- **自建 API 检索**(`docs/javascripts/api-search.js` + `assets/api-index.json`):
  支持四类查询——按名称、**按功能描述**(「注册工具」→ RegisterTool、
  「崩溃」→ SetAutoRestart)、按 `限定符.方法`(`memory.recall` → MemoryAPI.Recall)、
  按签名片段(`(string) error`)。并标出「仅内置」,避免外部插件作者踩空。

自建的理由:Material 内置搜索按整页文本索引,搜 `InjectText` 会列出所有提到它的
页面,但分不清哪条是它的定义;而且它要等 mkdocs build 才更新。

## 文档结构

- `docs/guide/`:快速开始、Go/Lua 首个插件、能力边界、打包发布、多平台、受限 SDK 与安全
- `docs/api/`:10 个按「你想做什么」划分的章节(工具/阶段/记忆/通道/配置/生命周期/
  事件/LLM/常量/桥接)+ 仅内置汇总页
- `docs/versions.md`:SDK 版本语义(跟随内核中版本、patch 恒为 .0)、
  1.0.0 是唯一破坏性变更、RPC 协议版本

## 验证

- `mkdocs build --strict` 零告警
- 23 个页面的全部站内链接与锚点可达(自动校验)
- 1440 / 768 / 390px 三视口:无横向溢出、无控制台错误
- 四种检索模式实测有结果且跳转锚点正确
- 构建产物 `site_build/` 已 gitignore

用法:`tools/apidoc/build.sh`(生成+构建)、`tools/apidoc/build.sh serve`(预览)。
This commit is contained in:
JianFeeeee
2026-09-24 12:08:37 +08:00
parent e97cafc8de
commit 0a6e2b7dc4
35 changed files with 8141 additions and 0 deletions

427
tools/apidoc/extract.go Normal file
View File

@ -0,0 +1,427 @@
// Command apidoc 从 SDK 源码提取公开 API 面,输出 JSON 供文档站生成使用。
//
// 设计约束:
// - **只用标准库**(go/ast、go/parser、go/token)——不需要网络、不依赖
// golang.org/x/tools,clone 下来就能跑。
// - **只读源码**,不做 import 解析:它按文件解析 `sdk/*.go`,因此不必处于
// 任何 Go module 内,也不会把依赖带进 SDK 主 module。
// - 输出是文档站生成的**唯一事实源**:文档里的签名、注释、示例代码块
// 全部来自这里,不手抄,避免文档与源码漂移。
//
// 用法:
//
// go run ./tools/apidoc -pkgdir ./sdk -out /tmp/api.json
package main
import (
"encoding/json"
"flag"
"fmt"
"go/ast"
"go/doc"
"go/parser"
"go/printer"
"go/token"
"log"
"os"
"path/filepath"
"regexp"
"sort"
"strings"
)
// Symbol 是一条 API 记录。
type Symbol struct {
Kind string `json:"kind"` // func / method / type / const / var
Recv string `json:"recv"` // 方法接收者(仅 method)
Name string `json:"name"` // 符号名
Signature string `json:"signature"` // 一行签名
Doc string `json:"doc"` // 文档注释(原文,含 markdown)
DocBrief string `json:"doc_brief"` // 首行摘要
File string `json:"file"`
Line int `json:"line"`
Group string `json:"group"` // 归属分组(由 groupFor 决定)
Exported bool `json:"exported"`
Examples []string `json:"examples"` // 注释里的 ```go 代码块
// Deprecated/Since 由注释里的标记提取,供文档打标。
Deprecated bool `json:"deprecated"`
// BuiltinOnly 标记「仅内核内置插件可用」——由 tiers.json 注入。
BuiltinOnly bool `json:"builtin_only"`
// Tier 是可见级别(public / builtin / bridge)——由 tiers.json 注入。
// 用显式字段而非从 TierReason 里找关键字判断:中文说明里「桥接」两字
// 在公开条目的理由里也会出现(“桥接模板注入…外部插件可用”),
// 靠 strings.Contains 判断会把公开 API 误标成装配点。
Tier string `json:"tier"`
TierReason string `json:"tier_reason"`
}
// Interface 是一个接口类型及其方法。
type Interface struct {
Name string `json:"name"`
Doc string `json:"doc"`
Methods []Symbol `json:"methods"`
}
// Package 是提取结果。
type Package struct {
ImportPath string `json:"import_path"`
Doc string `json:"doc"`
Symbols []Symbol `json:"symbols"`
Interfaces []Interface `json:"interfaces"`
// ConstGroups 保留源码里 const(...) 的分组结构。
ConstGroups []ConstGroup `json:"const_groups"`
SDKVersion string `json:"sdk_version"`
}
type ConstGroup struct {
Doc string `json:"doc"`
Consts []Symbol `json:"consts"`
}
var (
codeBlockRe = regexp.MustCompile("(?s)```(?:go|bash|json|)\n(.*?)```")
deprecatedRe = regexp.MustCompile(`(?i)\b(deprecated|已废弃|已弃用|即将移除)\b`)
)
func main() {
pkgdir := flag.String("pkgdir", "./sdk", "要解析的包目录")
out := flag.String("out", "-", "输出 JSON 路径,- 表示 stdout")
flag.Parse()
fset := token.NewFileSet()
pkgs, err := parser.ParseDir(fset, *pkgdir, func(fi os.FileInfo) bool {
return !strings.HasSuffix(fi.Name(), "_test.go")
}, parser.ParseComments)
if err != nil {
log.Fatalf("解析 %s 失败: %v", *pkgdir, err)
}
var result Package
for name, pkg := range pkgs {
result.ImportPath = name
// doc.New 会归并同名符号、抽取示例,并给出包级文档。
d := doc.New(pkg, name, doc.AllDecls)
result.Doc = strings.TrimSpace(d.Doc)
for _, f := range d.Funcs {
result.Symbols = append(result.Symbols, makeFunc(fset, f, *pkgdir))
}
for _, t := range d.Types {
result.Symbols = append(result.Symbols, makeType(fset, t, *pkgdir))
for _, m := range t.Methods {
result.Symbols = append(result.Symbols, makeMethod(fset, m, t.Name, *pkgdir))
}
if iface, ok := t.Decl.Specs[0].(*ast.TypeSpec).Type.(*ast.InterfaceType); ok {
result.Interfaces = append(result.Interfaces,
makeInterface(t, iface, fset, *pkgdir))
}
}
// const/var 用 Value 承载,按源码 const 块分组保留。
for _, v := range d.Consts {
result.Symbols = append(result.Symbols, makeValue(fset, v, "const", *pkgdir)...)
}
for _, v := range d.Vars {
result.Symbols = append(result.Symbols, makeValue(fset, v, "var", *pkgdir)...)
}
result.ConstGroups = groupConsts(fset, pkg, *pkgdir)
}
sort.Slice(result.Symbols, func(i, j int) bool {
if result.Symbols[i].Group != result.Symbols[j].Group {
return result.Symbols[i].Group < result.Symbols[j].Group
}
return result.Symbols[i].Name < result.Symbols[j].Name
})
for i := range result.Interfaces {
sort.Slice(result.Interfaces[i].Methods, func(a, b int) bool {
return result.Interfaces[i].Methods[a].Name < result.Interfaces[i].Methods[b].Name
})
}
if err := applyTiers(&result); err != nil {
log.Fatalf("应用能力分层失败: %v", err)
}
data, err := json.MarshalIndent(result, "", " ")
if err != nil {
log.Fatal(err)
}
if *out == "-" {
os.Stdout.Write(data)
return
}
if err := os.WriteFile(*out, append(data, '\n'), 0o644); err != nil {
log.Fatal(err)
}
fmt.Fprintf(os.Stderr, "提取 %d 个符号 → %s\n", len(result.Symbols), *out)
}
func oneLine(s string) string {
return strings.Join(strings.Fields(s), " ")
}
func brief(doc string) string {
for _, line := range strings.Split(doc, "\n") {
line = strings.TrimSpace(line)
if line != "" && !strings.HasPrefix(line, "//") {
return line
}
}
return ""
}
func examplesOf(doc string) []string {
var out []string
for _, m := range codeBlockRe.FindAllStringSubmatch(doc, -1) {
out = append(out, strings.TrimRight(m[1], "\n"))
}
return out
}
func finish(s *Symbol) Symbol {
s.Doc = strings.TrimSpace(s.Doc)
s.DocBrief = brief(s.Doc)
s.Examples = examplesOf(s.Doc)
s.Deprecated = deprecatedRe.MatchString(s.DocBrief)
s.Group = groupFor(s)
return *s
}
func makeFunc(fset *token.FileSet, f *doc.Func, pkgdir string) Symbol {
pos := fset.Position(f.Decl.Pos())
return finish(&Symbol{
Kind: "func",
Name: f.Name,
Signature: sigOf(fset, f.Decl),
Doc: f.Doc,
File: rel(pkgdir, pos.Filename),
Line: pos.Line,
Exported: ast.IsExported(f.Name),
})
}
func makeMethod(fset *token.FileSet, f *doc.Func, recv, pkgdir string) Symbol {
pos := fset.Position(f.Decl.Pos())
return finish(&Symbol{
Kind: "method",
Recv: recv,
Name: f.Name,
Signature: sigOf(fset, f.Decl),
Doc: f.Doc,
File: rel(pkgdir, pos.Filename),
Line: pos.Line,
Exported: ast.IsExported(f.Name),
})
}
func makeType(fset *token.FileSet, t *doc.Type, pkgdir string) Symbol {
pos := fset.Position(t.Decl.Pos())
return finish(&Symbol{
Kind: "type",
Name: t.Name,
Signature: "type " + t.Name + " " + typeShape(fset, t),
Doc: t.Doc,
File: rel(pkgdir, pos.Filename),
Line: pos.Line,
Exported: ast.IsExported(t.Name),
})
}
func makeValue(fset *token.FileSet, v *doc.Value, kind, pkgdir string) []Symbol {
// 一个 const/var 声明里可能有多组名字(如 CapText/CapFile/... 同块),
// 拆成多条——把名字用逗号拼成一条在文档里很难读,检索也搜不到。
var out []Symbol
for _, spec := range v.Decl.Specs {
vs, ok := spec.(*ast.ValueSpec)
if !ok {
continue
}
docText := strings.TrimSpace(vs.Doc.Text())
if docText == "" {
docText = strings.TrimSpace(v.Doc)
}
for _, n := range vs.Names {
if !ast.IsExported(n.Name) {
continue
}
pos := fset.Position(n.Pos())
out = append(out, finish(&Symbol{
Kind: kind,
Name: n.Name,
Signature: kind + " " + n.Name,
Doc: docText,
File: rel(pkgdir, pos.Filename),
Line: pos.Line,
Exported: true,
}))
}
}
return out
}
// makeInterface 从接口类型的 AST 直接读方法。
//
// 注意:不能用 doc.Type.Methods —— 那个字段只收集**具名类型的方法声明**
// (即 `func (x T) M()`),不含接口内嵌的方法列表。接口成员只能在 AST 的
// InterfaceType.Methods 里拿到。
func makeInterface(t *doc.Type, iface *ast.InterfaceType, fset *token.FileSet, pkgdir string) Interface {
it := Interface{Name: t.Name, Doc: strings.TrimSpace(t.Doc)}
for _, field := range iface.Methods.List {
if len(field.Names) == 0 {
// 内嵌接口(如 interface { io.Closer }):记为一条说明性条目。
pos := fset.Position(field.Pos())
embedded := oneLine(exprString(field.Type))
it.Methods = append(it.Methods, finish(&Symbol{
Kind: "embedded",
Recv: t.Name,
Name: embedded,
Signature: embedded,
Doc: strings.TrimSpace(field.Doc.Text()),
File: rel(pkgdir, pos.Filename),
Line: pos.Line,
Exported: true,
}))
continue
}
ft, ok := field.Type.(*ast.FuncType)
if !ok {
continue
}
pos := fset.Position(field.Pos())
sig := oneLine(exprString(ft))
for _, n := range field.Names {
if !ast.IsExported(n.Name) {
continue
}
full := name(n.Name) + strings.TrimPrefix(sig, "func")
it.Methods = append(it.Methods, finish(&Symbol{
Kind: "method",
Recv: t.Name,
Name: n.Name,
Signature: full,
Doc: strings.TrimSpace(field.Doc.Text()),
File: rel(pkgdir, pos.Filename),
Line: pos.Line,
Exported: true,
}))
}
}
_ = iface
return it
}
// exprString 用 go/printer 把 AST 节点还原成源码文本。
func exprString(n ast.Node) string {
var buf strings.Builder
if err := printer.Fprint(&buf, token.NewFileSet(), n); err != nil {
return "?"
}
return buf.String()
}
func name(s string) string { return s }
func sigOf(fset *token.FileSet, fn *ast.FuncDecl) string {
if fn.Type == nil {
return fn.Name.Name
}
// 用源码原文截取签名,保证与源码逐字一致(不重新格式化)。
start := fset.Position(fn.Pos()).Offset
end := fset.Position(fn.Type.End()).Offset
src, err := os.ReadFile(fset.Position(fn.Pos()).Filename)
if err == nil && start < end && end <= len(src) {
return oneLine(string(src[start:end]))
}
return fn.Name.Name
}
func typeShape(fset *token.FileSet, t *doc.Type) string {
spec, ok := t.Decl.Specs[0].(*ast.TypeSpec)
if !ok {
return "?"
}
start := fset.Position(spec.Type.Pos()).Offset
end := fset.Position(spec.Type.End()).Offset
src, err := os.ReadFile(fset.Position(spec.Type.Pos()).Filename)
if err != nil || start >= end || end > len(src) {
return "?"
}
raw := src[start:end]
// 结构体只保留第一行 + 字段数提示,完整字段在 API 页单独展开。
if len(raw) > 160 {
return oneLine(string(raw[:160])) + " …"
}
return oneLine(string(raw))
}
func rel(base, p string) string {
if r, err := filepath.Rel(base, p); err == nil {
return r
}
return p
}
// groupFor 把符号归到文档站的章节。规则集中在这里,避免散落。
func groupFor(s *Symbol) string {
switch {
case s.Recv == "PluginSDK" || strings.HasPrefix(s.Name, "PluginSDK"):
return "plugin-sdk"
case s.Recv == "StageContext":
return "stages"
case s.Kind == "const" || s.Kind == "var":
return "constants"
case s.Recv == "" && s.Kind == "func":
return "functions"
case s.Kind == "type":
return "types"
case s.Recv != "":
return "interfaces"
}
return "misc"
}
func groupConsts(fset *token.FileSet, pkg *ast.Package, pkgdir string) []ConstGroup {
var groups []ConstGroup
for _, f := range pkg.Files {
for _, decl := range f.Decls {
gd, ok := decl.(*ast.GenDecl)
if !ok || gd.Tok != token.CONST {
continue
}
g := ConstGroup{}
if gd.Doc != nil {
g.Doc = strings.TrimSpace(gd.Doc.Text())
}
for _, spec := range gd.Specs {
vs, ok := spec.(*ast.ValueSpec)
if !ok {
continue
}
var names []string
for _, n := range vs.Names {
if ast.IsExported(n.Name) {
names = append(names, n.Name)
}
}
if len(names) == 0 {
continue
}
pos := fset.Position(vs.Pos())
g.Consts = append(g.Consts, Symbol{
Kind: "const",
Name: strings.Join(names, ", "),
Doc: strings.TrimSpace(vs.Doc.Text()),
DocBrief: brief(strings.TrimSpace(vs.Doc.Text())),
File: rel(pkgdir, pos.Filename),
Line: pos.Line,
Exported: true,
Group: "constants",
})
}
if len(g.Consts) > 0 {
groups = append(groups, g)
}
}
}
return groups
}