aionclaw 支持三种方式为自定义 api 生成文档:1. 在【我的技能】中手动编辑「接口说明」文本框,首行必须为 # 接口名称;2. 用 cli 工具扫描 json schema 自动生成 markdown 草稿(需手动粘贴生效);3. 企业版支持从 openapi yaml 一键导入或通过 skill.yaml 的 docs_source 字段绑定版本化文档文件。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要为 AionClaw 中已接入的自定义 API 接口(比如内部系统 HTTP 接口、本地脚本封装接口、数据库查询插件等)快速生成可读性强、结构清晰、带参数示例的说明文档,避免每次调试都翻代码或靠口头交接。
在技能市场中为已有接口创建专属文档页
打开 AionClaw 客户端 → 左侧导航栏点击【技能市场】→ 顶部切换到【我的技能】标签页 → 找到目标接口所在的技能卡片,点击右下角「…」→ 选择【编辑技能详情】。
进入编辑页后,向下滚动到「接口说明」文本框。这里不是简单写几句话的地方:【必须用 Markdown 语法书写,且首行需以 `# 接口名称` 开头,否则 AionClaw 不会识别为有效文档入口】。支持二级标题(## 请求方式)、代码块(```http)、参数表格、响应示例,但不支持 HTML 标签或嵌入图片。
填完保存后,该接口在技能卡片上会自动显示「? 文档」小图标,点击即可唤出渲染后的富文本页面——所有参数字段、错误码、调用链路都会按 Markdown 结构高亮呈现。
通过命令行工具自动生成基础文档骨架
方法一:使用内置 CLI 工具扫描接口定义文件
确保你的接口已按 OpenClaw 规范定义了 JSON Schema(如 `api_schema.json`),路径在技能目录下的 `/schema/` 子目录中。打开终端,cd 到 AionClaw 安装根目录 → 执行:aionclaw-cli docgen --schema ./skills/myapi/schema/api_schema.json --output ./skills/myapi/README.md。
这一步会生成含请求路径、method、必选/可选参数、类型约束、默认值的完整 Markdown 文档草稿。注意:【生成的 README.md 不会自动同步到客户端界面,必须手动复制粘贴进上一节提到的「接口说明」文本框中才生效】。
方法二:从 Swagger/YAML 文件一键导入(仅限企业版)
如果你的接口已部署 Swagger UI,且导出过 `openapi.yaml`,可在【技能市场】→【新建技能】→【从 OpenAPI 导入】中直接拖入该文件。AionClaw 会解析全部 endpoints 并自动创建技能条目,同时把 `info.description` 和 `paths.*.description` 内容原样转为文档首页内容。此方法生成的文档无需二次粘贴,立即可用。
让文档随接口版本自动更新
第一步:在技能配置文件 `skill.yaml` 中声明文档源位置
用文本编辑器打开该技能根目录下的 `skill.yaml`,在末尾添加字段:
`docs_source: ./docs/v2.1.0.md`
第二步:将实际文档文件放入指定路径
在技能目录下新建 `docs` 文件夹,把当前版本的 Markdown 文档命名为 `v2.1.0.md` 放入其中。AionClaw 启动时会自动读取该路径内容,并在客户端「? 文档」页中展示。
第三步:每次发布新版本时更新文件名和 YAML 引用
例如升级到 v2.2.0,就把新文档存为 `v2.2.0.md`,并同步修改 `skill.yaml` 中的 `docs_source` 值。AionClaw 不会保留历史版本文档,只加载 YAML 指向的那一个文件。











