api-review
API设计评审与一致性审计工具
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:api-review。 它的用途是:API设计评审与一致性审计工具 完整的 Skill 内容见:https://321skill.com/skills/api-review/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'使用api-review技能审查当前项目所有公开API,检查命名一致性、参数顺序和文档完整性,并对比pandas库的范例。'它会自动执行Surface Inventory编目所有公共接口,然后进行Exemplar Research,最后生成一份包含批准/阻止决策和具体行动项的报告,如'将create_user函数重命名为register_user,截止日期2025-06-01,责任人@张三'。
介绍
这个Skill解决了API发布前表面设计评审的痛点。在实际开发中,团队常常面临接口命名不一致、参数顺序混乱、文档缺失或版本号不兼容等问题,导致上线后频繁返工。通过自动化的五步工作流,它帮助工程师系统性地检查API质量,避免因设计缺陷引发的线上故障。
使用方式很简单,你只需要在对话中触发api、design或consistency等关键词,或直接指定要审查的API变更范围。Skill会自动执行:①Surface Inventory(编目所有公开API,含稳定性等级和版本元数据);②Exemplar Research(检索pandas、requests等语言标杆库的命名/分页/错误处理模式);③Consistency Audit(对比差异并定位重复、泄漏抽象等问题);④Documentation Governance(验证文档完整性、SemVer合规、弃用时间线);⑤Evidence Log(生成最终报告,含批准/有条件批准/阻止决策及具体行动项)。
它非常适合需要频繁发布或维护公共API的团队,尤其是后端开发、API架构师和测试工程师。在微服务架构或开源项目中,当多个团队并行开发时,该工具能确保API表面统一对齐规范,减少跨团队沟通成本。
建议在项目早期或每次PR合并前统一使用此工具。需要注意的是,它目前主要支持Rust、Python等语言,并依赖Night Market的imbue:proof-of-work和imbue:structured-output插件。初次配置需要安装相关插件并设置共享上下文,但之后即可无缝集成到CI/CD流水线中。
常见问题
需要安装Night Market才能使用吗?
是的,该Skill是Night Market生态的一部分,需要先安装Night Market插件并启用pensive模块。
支持哪些编程语言?
主要支持Rust(通过`rg`查找`pub`符号)和Python(通过模式匹配非下划线`def`),其他语言需自行扩展Exemplar Research步骤。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/api-review/raw/index.md 读取 api-review 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/api-review/raw/index.md(查看排版版本)