OpenAPI接口文档校验
输入代码仓库范围或接口路径,扫描路由与认证逻辑并对照OpenAPI文档,输出缺失接口、定义偏差及可执行的修复建议。
功能与用途
用于检查 Bifrost 代码中的 HTTP 接口是否与 OpenAPI 文档一致。输入可为全仓、管理接口、推理接口或指定路径范围;校验会对照路由方法与路径、参数、请求和响应定义,以及实际认证行为,整理缺失、过期或不匹配项并给出文件位置和修复建议。默认只生成审计报告,不修改文件;需要修复时,须明确提出或批准修复计划。适合在熟悉该项目代码结构的前提下使用。
适用场景
- 发布前检查接口覆盖:扫描新增控制器路由,对照 OpenAPI 找出尚未记录的接口和方法、路径差异。
- 核对认证文档:追踪中间件和处理器的实际认证行为,检查公开接口或虚拟密钥接口的安全定义是否准确。
- 排查文档漂移:针对指定路径比较代码与文档中的参数、请求体、响应状态和内容类型,形成修复清单。
适用人群
- 维护 Bifrost HTTP API 的后端工程师
- 负责 OpenAPI 文档的接口维护者
- 进行 API 安全与认证审查的工程师
使用步骤
- 选择全量、管理、推理或指定路径审计范围。
- 扫描路由注册、认证中间件和处理器行为。
- 解析 OpenAPI 定义并比较接口与安全信息。
- 查看带文件位置的差异报告和修复建议。
- 需要改动时,确认修复计划后再执行。
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
- 使用难度
- 专业
- 版本
- main
- 最近更新
- 2026-11-03
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
Scan Bifrost HTTP controllers/handlers/integrations and validate OpenAPI API coverage, route methods/paths, parameters, request/response docs, and auth/security information. Use when asked to audit missing or incorrect APIs, compare controllers against docs/openapi, validate auth information, or fix API documentation drift. Invoked with /api-validator [scope] [--fix].