用途:校验 OpenAPI/OAS/Swagger 规范文件,检查完整性与最佳实践,评估是否适合 AI 代理消费,审计 API 文档质量,并支持将 RAML 转为 OAS。
主要能力:基于规则集检查 OAS 3.0.x/3.1.x YAML 规范,覆盖 11 条规则——必须为 OAS 格式;info.title 须以 API 结尾;info.version 须为 MAJOR.MINOR.PATCH 语义化版本;每个操作须有具描述性的 operationId;操作须有带上下文的 description(含遗留字段映射、警告、错误恢复说明);须提供示例;schema 属性须有描述;响应类型须完整文档化;受限取值须用 enum;required 须显式列出;info.description 须非空并说明领域与用途。另建议 API 项目采用 api.yaml、README.md、docs/、exchange.json 的结构。
使用方式:先安装 npm install -g anypoint-cli-v4,再执行 anypoint-cli-v4 plugins:install anypoint-cli-api-project-plugin。校验分两遍:第一遍运行 anypoint-cli-v4 api-project validate --json --location=./path/to/folder/with/oas 检查语法;通过后第二遍加 anypoint-cli-v4 api-project validate --json --location=./path/to/folder/with/oas --local-ruleset skills/api-spec-validator/scripts/ruleset.yaml 做合规校验。修复建议按规则分类,机械项可脚本化,语义项需理解 API 领域,修复后重跑第二遍直至通过。
适用场景:API 规范评审、文档质量审计、AI 代理友好化改造、RAML 迁移。
限制:资料未提供官方支持平台、收费与价格信息;示例中的组织 ID 等为给定值,非通用配置。