文档文章

API 与 package 参考

通过 reference 层先选对 package surface,再深入实现细节。

参考6 分钟

只要把公开 package、核心入口和各自职责讲清楚,toolkit 的接入门槛就会明显降低。

这一页不是自动生成的 API dump,而是一个实用的定位层,帮助你先找到正确的 package 或 surface,再决定要不要深入读仓库实现。

适合人群
集成开发者
难度
中级
最近更新
2026年7月28日
快速开始
先从产品层入口理解整体接入方式,再决定具体 package 级细节。
Toolkit 仓库
直接查看仓库、release 和 package 布局。

先选对 surface

先把三层分开: Web 产品层、已发布 toolkit package、以及支撑它们的内部模块图。

大多数用户应该先判断自己需要的是浏览器工作流、package 集成,还是更深的扩展/贡献路径。这个判断比逐个翻源码目录更快缩小范围。

明确 package 职责

这些层彼此相关,但不应该被写成同一种入口。

  • 想要引导式体验和快速验证时,用 Web app。
  • 想把转换能力接入其他系统时,用已发布 package。
  • 只有在扩展 parser、generator 或分析层时,才需要进入仓库内部。

把 orchestration 说清楚

具体命名会随着发布版本演进,但 reference 层始终应该讲清楚: 哪个 package 负责 orchestration,哪个负责 parse,哪个负责生成目标格式。

典型的集成接缝

ts
import { transformSchema } from "@aio/sdk";
import { parseTypeScript } from "@aio/parser-typescript";
import { generateJsonSchema } from "@aio/generator-json-schema";

const parsed = parseTypeScript(sourceText);
const result = transformSchema({
  generator: generateJsonSchema,
  parsed,
});