8.0
热点
AI SCORE
编程提效2026-08-19 23:44
Claude Code Skill：逆向解析未文档化 API
dev.to · AI#Claude#API#工具
Editor brief · 编辑速览
开发者自建 Claude Code/Codex CLI 技能 API Archaeologist，直接从源码反向推导 API 结构、路由与认证情况，解决接手里程碑项目时的文档缺失痛点。
因为"文档在代码里"不是一种文档策略。
上个月我加入了一个新团队。第一天的任务：给计费服务加一个功能。
第一天的现实：我打开 API 文档，发现它们还是 2022 年的。有一半的路由已经被重写了。另一半从来就没有文档。
于是我做了每个后端开发都会做的事——grep。
grep -r "app.get|app.post|router." src/ --include="*.js"
四个小时后，我有了一本满是端点的笔记本、一个头痛，以及零信心——我并没有找到所有东西。
我找到了有路由但没有文档的端点。我找到了文档存在但路由已不存在的文档。我发现了一个从 2022 年就躺在那儿的、零认证检查的 GET /invoices/:id 端点。
这是常态。但这不应该成为常态。
如果我能往一个仓库里扔一个文件，让 Claude Code 为我绘制出整个 API 层呢？
不依赖注解。不依赖现有的 OpenAPI 规范。从实际的代码出发。
API Archaeologist 是一个 Claude Code / Codex CLI skill，它可以读取你的源代码并反向工程出你的 API 层。
它生成两份内容：
API_DISCOVERY.md — 一个完整的目录，包含 Mermaid 图表
openapi-draft.yaml — 一份 OpenAPI 规范草稿
这个 skill 只是一个 SKILL.md 文件。Claude Code 读取它并遵循其中的指令。
发现路由定义
追踪处理器、DTO、中间件、服务和数据库调用
映射认证和授权
找到外部 API 调用和集成
标记潜在的安全和可靠性风险
生成 API_DISCOVERY.md 和 openapi-draft.yaml
如果你的代码库已经有注解、装饰器或现有规范，Swagger 和 OpenAPI Generator 都很棒。
这是为另一类代码库准备的：
它读取实际的源代码，而不是依赖现有文档。
安装方法：
mkdir -p ~/.claude/skills/api-archaeologist
curl -o ~/.claude/skills/api-archaeologist/SKILL.md https://raw.githubusercontent.com/prasen-sky/api-archaeologist/main/skills/api-archaeologist/SKILL.md
mkdir -p ~/.codex/agents/skills/api-archaeologist
curl -o ~/.codex/agents/skills/api-archaeologist/SKILL.md https://raw.githubusercontent.com/prasen-sky/api-archaeologist/main/skills/api-archaeologist/SKILL.md
或者克隆仓库：
git clone https://github.com/prasen-sky/api-archaeologist.git
cp api-archaeologist/skills/api-archaeologist/SKILL.md ~/.claude/skills/api-archaeologist/
导航到你的后端仓库并运行：
claude /api-archaeologist
codex $api-archaeologist
然后审查生成的报告，并将发现与你的代码库进行核对。
有趣的部分不是生成了又一个 API 文档工具。
而是意识到代码库里已经存在多少有用的信息。
路由、中间件、认证、数据库调用、第三方 API 以及请求/响应结构都已经在那里了。
问题是找到并连接所有这些碎片。
OpenAPI 输出是一份草稿。类型和行为可能需要手动验证。
动态或大量使用元编程的路由可能更难分析。
大型 monorepo 最好按服务逐一分析。
如果你的 API 文档已经过时，这可能会派上用场。
GitHub: [https://github.com/prasen-sky/api-archaeologist]
在一个仓库上试试，然后告诉我它发现了什么。