用途:在部署前审查 OpenAPI(Swagger)或 AsyncAPI 规范中的安全问题,以安全检查清单的形式约束 API 设计。
主要能力:检查 API 服务器是否使用 HTTPS、操作是否具备唯一 operationId、是否提供操作说明、是否定义安全方案(OAuth2/API 密钥/Bearer 令牌)、请求体模式是否包含约束、是否定义 401/403/429 错误响应、是否记录限流响应头、路径参数是否被正确约束、是否避免动态路径与 eval。
使用方式:确认目标 API 规范文件(YAML/JSON)后运行 lint,例如 spectral lint <spec-file> --format json > spectral-results.json,可配合自定义规则集 spectral lint <spec> --ruleset .spectral.yml --format json 或 spectral lint openapi.yaml --format pretty。随后解析 JSON 输出,以表格形式列出编号、严重级别、规则、路径、消息与行号,并按严重级别汇总问题、给出具体修复建议。自定义规则集可通过 .spectral.yml 扩展 spectral:oas,并定义如 oas3-server-https 的规则。
前置条件:需安装 Spectral(npm install -g @stoplight/spectral-cli),并用 spectral --version 验证。
限制:资料未提供该技能的安装方式、具体定价或运行环境要求;实际检测效果取决于所选规则集与规范文件质量。