SuperAPI AI 工具集

audit-api-consistency

编程与开发

查看项目

更新于 10-16 09:07

技能介绍

用途

该技能用于审计现有 API 端点的一致性。当用户提出检查 API 质量、审查 API 模式、审计端点或查找 API 不一致的请求时触发。它只分析已有 API,不会创建新 API。

主要能力

工作流程包括:读取项目上下文(.chalk/docs/engineering/ 中的 API 设计文档、架构文档、风格指南、历史审计报告);发现路由定义并建立端点清单;按一致性类别逐项分析;按严重程度分类问题;生成修复建议;输出报告(在对话中呈现,或按用户要求写入 .chalk/docs/engineering/<n>_api_audit.md);提供执行摘要。

审计的一致性类别包括:

  1. URL 命名模式:复数与单数、大小写风格、嵌套深度、动词使用、路径 ID 格式、尾部斜杠。
  2. HTTP 方法使用:GET 带副作用、用 POST 做检索、PUT 与 PATCH 混淆、DELETE 语义、状态码正确性。
  3. 错误响应格式:结构一致性、错误码、验证错误格式、HTTP 状态码准确性、错误中间件、生产环境堆栈跟踪泄露。
  4. 分页方式:分页是否存在、游标与偏移、参数命名、默认值、最大限制、响应元数据结构。
  5. 认证与授权:认证中间件覆盖、认证头格式、敏感端点缺少认证、角色/作用域检查、公开端点文档。
  6. 版本控制:是否使用版本、版本格式、未版本化端点、已弃用版本。
  7. 响应封装:包装一致性、单资源与集合区分、null 处理、时间戳格式。

严重程度分为 Critical、High、Medium、Low。每条问题包含当前状态、期望状态、具体代码修改或迁移路径、是否为破坏性变更。

使用方式

技能按以下顺序扫描大型代码库:先找到路由文件,再提取端点清单,检查错误中间件,抽查 3-5 个端点处理器,最后对比偏离主流模式的端点。报告格式包含执行摘要、按严重程度统计、主流模式(含采用率)、各严重程度的具体发现、迁移建议(按优先级排序)以及遗留端点说明。

适用场景

适用于检查 API 质量、审查 API 模式、审计端点、查找 API 不一致等场景。

限制

该技能只分析现有 API,不创建新 API。审计应基于项目自身的主流约定,而非外部理想标准。反模式包括:只检查命名而不检查行为、忽略遗留端点、不提供迁移路径、按理想标准而非项目约定审计、遗漏认证缺口、一次性审计无后续跟进。