前言¶
对接第三方服务时，常见情况是文档篇幅长、结构散：认证方式藏在附录里，错误码分散在多个页面，示例代码和当前版本对不上。自己通读一遍再手写 curl 或 SDK 调用，往往要占掉大半天。
若把整份文档丢给通用对话，输出容易泛泛而谈，也不一定能按「端点表 + 可运行示例 + 错误码表」这种对接时随手翻的格式落地。下面介绍 SkillHub 社区 Skill「API文档速读」（坐标 @user_70c2f807/api-doc-speed-reader，版本 1.0.0）：它用固定的 SKILL.md 工作流，指导 Agent 在用户粘贴文档的前提下，做结构化速读与示例生成。Skill 标注 requires_api_key=false，安装后不需要额外 API Key。
这是什么¶
「API文档速读」是发布在 SkillHub 的社区 Skill（source: community），分类为 knowledge-management，子类包括信息检索、摘要总结、文档问答。维护者为 user_70c2f807（页面展示作者名 QQQ）。官方入口：
- API 坐标页：https://api.skillhub.cn/user_70c2f807/api-doc-speed-reader
- SkillHub 详情页：https://www.skillhub.cn/skills/user_70c2f807/api-doc-speed-reader
定位一句话：快速解读用户提供的第三方 API 文档，生成调用示例、参数说明、错误码速查和常见坑点提示，缩短对接准备时间。适用触发词包括 API 文档、接口文档、API 对接、api documentation、api integration 等；明确不用于 API 开发、后端编程、接口测试、SDK 开发等场景。
核心功能¶
以下能力均来自 Skill 包内 SKILL.md 的说明：
- 从长文档抽核心：识别 RESTful / GraphQL / RPC 等结构，整理端点、请求方法、URL、参数与响应字段。
- 多语言调用示例：优先生成 curl，并可生成 Python、JavaScript、Java 等示例；区分必填与选填参数。
- 错误码速查：表格化错误码、含义与处理建议。
- 坑点与限制提示：认证方式、频率限制、编码与分页等文档里容易漏看的细节。
- 接口对比：用户提供两份文档时，可生成差异对比表；也支持新旧版本对比（需分别粘贴文档）。
输出倾向「速查优先」：接口一览表、参数表、示例代码、错误码表、常见坑点分块呈现，示例中的 Token / Key 使用占位符。
安装与启用¶
SkillHub 推荐两种方式：让 Agent 按安装指南执行，或使用 skillhub CLI 装到当前 Agent 的 skills 目录（未指定 --dir 时默认 ./skills/，多数客户端不会加载）。
方式一：安装提示词（官网卡片原文）
请根据 https://skillhub.cn/install/skillhub.md，安装 @user_70c2f807/api-doc-speed-reader。
方式二：SkillHub CLI
先确认 CLI 是否可用：
command -v skillhub && skillhub --version
未安装时可按 https://skillhub.cn/install/skillhub.md 执行官方安装脚本。安装 Skill 时需把 --dir 指向本机 Agent 的 skills 目录，例如：
# Cursor
skillhub install @user_70c2f807/api-doc-speed-reader --dir ~/.cursor/skills/
# Claude Code
skillhub install @user_70c2f807/api-doc-speed-reader --dir ~/.claude/skills/
# Codex CLI（用户目录或项目 .agents/skills/，按实际环境选择）
skillhub install @user_70c2f807/api-doc-speed-reader --dir ~/.codex/skills/
方式三：Zip 包
SkillHub 提供 1.0.0 压缩包下载地址：
https://api.skillhub.cn/api/v1/download?slug=@user_70c2f807/api-doc-speed-reader
解压后将 Skill 目录放到上述 skills 路径，并重启或重新加载 Agent 使 Skill 生效。
典型用法¶
Skill 要求用户粘贴文档内容或关键章节，Agent 不能仅凭 URL 抓取外部页面，也不会实际发起 HTTP 请求。可按下面节奏使用：
- 在对话中说明要对哪套 API 做速读，并粘贴文档（至少包含端点 URL 与参数说明；过长时可分批发核心接口、认证、错误码等段落）。
- Agent 按 Skill 四步执行：接收文档 → 结构化整理 → 生成示例 → 补充认证、限流与错误处理提示。
- 按需追加指令，例如「生成 Python 调用示例」「整理错误码」「这个 API 有什么坑」「对比这两段文档里的接口差异」。
Skill 内给出的对话示例（节选）：
用户：帮我看看这个API文档 [粘贴文档]
→ 提取核心信息，生成速查表
用户：生成调用示例
→ 用 Python/curl/JavaScript 生成可直接使用的代码
用户：这个接口的错误码有哪些？
→ 整理错误码表格，附解决方案
复杂业务逻辑仍建议阅读原文；GraphQL 可粘贴 Schema 与 Query 示例后按同样流程整理。
适用场景与注意¶
适合谁
- 需要快速摸清第三方 REST / GraphQL 等公开文档的接入同学。
- 要在联调前统一整理认证、端点表、错误码和可复制示例的开发者。
限制与坑（Skill 原文强调）
| 点 | 说明 |
|---|---|
| 文档来源 | 必须粘贴内容，不能单靠链接让 Agent 自动读站外文档 |
| 请求行为 | 只生成示例代码，不执行真实 HTTP |
| 时效性 | 以用户提供的文档版本为准，线上 API 可能已变更 |
| 深度 | 不替代完整阅读；SDK 完整封装建议用 OpenAPI Generator 等工具 |
| 测试 | 接口实测请用 Postman、Insomnia 等，而非本 Skill |
SkillHub 页面侧栏显示该 Skill 约 780 次下载（抓取资料与页面数据一致）；腾讯安全扫描结果为「安全，无风险」。社区来源、作者未认证（isAuthorVerified: false），接入生产前请自行核对文档与合规要求。
结尾¶
「API文档速读」把「读文档 → 表格化速查 → 多语言示例 → 错误码与坑点」收成一套 Agent 可重复执行的说明，适合在已有文档文本的前提下提高对接准备效率。安装与说明见 SkillHub：https://www.skillhub.cn/skills/user_70c2f807/api-doc-speed-reader ，坐标页：https://api.skillhub.cn/user_70c2f807/api-doc-speed-reader 。
