用途:api-docs-quality-report 是一个 API 文档审计 Skill,爬取文档站点上的每个 API 参考端点页面,逐页评分并输出交互式 HTML 报告。
主要能力:按 5 项检查评分——端点描述、OpenAPI 规范、请求体参数描述、响应码、响应结构;检测影响 ≥60% 端点的站点级模式(如普遍缺失错误码、空响应结构、自由格式请求体、仅内联规范、一句话描述、仅 422 校验错误);汇总最多 10 个高影响问题并生成评分卡。
使用方式:只需提供一个文档 URL。先尝试获取 <docs_url>/llms.txt 发现接口页面并按路径分类;再检查独立 OpenAPI 规范(Link 头 rel="openapi"/"describedby"、/openapi.json、/openapi.yaml、/api/openapi.json 等);随后抓取并解析每个端点页;评分并生成报告到 /mnt/user-data/outputs/<slug>-api-audit-report.html,最后调用 present_files 交付。
限制:文档说明较详细,但具体评分规则见 references/scoring-rules.md,HTML 模板见 references/html-template.md,本次资料未提供其内容。文档明确禁止在全部页面抓取评分前生成 HTML、禁止跳过端点页、禁止仅凭标题推断评分、不得将仅记录 200 的响应码判为通过、schema: {} 判为失败、additionalProperties: true 至少警告。超过 200 个端点时按每批 20 分批抓取。robots.txt 阻止的页面不抓取并报告。缺失事实(如收费、平台支持)暂未提供。