API 质量 · v1.0.0

API 契约验证器

分析 API 文档,并通过安全的真实请求验证文档契约。

公开制品已开放
可下载包与本页展示的源提交和校验值一一对应。

最终交付结果

对比文档行为与真实响应,同时避免把契约验证变成压力测试或渗透测试。

适用场景

  • 需要验证 Markdown、Office、文本或 OpenAPI 格式的接口文档时。
  • 需要通过安全的 GET 或 HEAD 请求确认可达性、字段、类型和示例时。

不包含的能力

  • 不代替用户对项目范围、账号权限、外部变更和商业后果的最终授权。
  • 不把仓库静态检查描述为所有平台、供应商账号或真实生产环境中的运行时认证。

需要输入

  • API 文档与目标环境
  • 必要时提供已批准的认证材料与测试边界

交付输出

  • 契约提取与验证报告
  • 验证证据、差异与有边界的建议

自然语言触发示例

使用 $api-contract-verifier 对比 OpenAPI 文档与预发布服务的安全请求响应。

权限地图

文件写入

可能读取用户提供的文档,并写入脱敏验证记录。

命令执行

可能运行安全的 HTTP 与文档检查命令。

网络执行

只向用户授权的 API 端点发送有边界的请求。

账号读取

可能使用现有授权凭据通道,但不会复制秘密本身。

浏览器读取

可能在浏览器中查看 API 文档,但不修改账号状态。

外部变更不需要

默认使用安全只读请求,不执行真实业务写操作。

环境与要求

支持的 Agent

  • Codex
  • Claude Code

支持的平台

  • macOS
  • Linux
  • Windows

需要的工具

  • HTTP client
  • authorized API documentation

数据处理

处理用户授权的接口文档、测试请求和脱敏响应;默认不持久化令牌、Cookie、个人数据或完整生产响应。

凭据处理

仅使用用户已授权的现有安全凭据通道;不得把令牌、密钥、Cookie、私钥或真实用户数据复制进 Skill、日志、报告或公开制品。

验证证据

版本 1.0.0 已在隔离的 macOS 环境完成文档提取、OpenAPI 规范化、真实回环 HTTP 请求、差异判定和凭据泄漏检查;验证不包含第三方生产服务或真实客户数据。

等级
已验证
检查日期
2026-10-12
复验截止
2027-01-10
源提交
fac86e9d2646

验证环境

  • macOS 26.2
  • Python 3.9.6
  • Local isolated HTTP fixture on 127.0.0.1

检查对象

  • Markdown, HTML, PDF, and OpenAPI JSON extraction
  • OpenAPI normalization and normalized-contract validation
  • GET and HEAD requests with no retry or redirect
  • PASS, WARNING, ERROR, and BLOCKED comparison outcomes
  • Credential redaction from retained evidence

证据编号

  • api-contract-verifier-self-test
  • api-contract-verifier-unit-tests
  • api-contract-verifier-document-extraction
  • api-contract-verifier-loopback-probe
  • api-contract-verifier-secret-redaction

限制与支持

已知限制

  • 验证结论只适用于记录中的确切制品、源提交、环境和测试范围,不代表所有供应商账号、地区或未来版本都具有相同行为。
  • Agent、平台和服务商界面会持续变化,执行前仍需读取当前环境并遵守明确的确认门禁。
  • 真实网络验证仅使用本机隔离夹具,没有调用第三方生产 API。
  • 验证覆盖脚本执行链路,不代表每个 Agent 版本的自然语言路由都已认证。
  • 扫描版 PDF OCR、旧版 DOC/PPT 和带真实鉴权的远程接口仍需在具体项目中验证。

权限变化

  • 当前版本没有声明相对于上一版本的权限变化;首次公开版本以本页权限地图为准。

渠道
通过 support@xiaoyuelabs.com 或站内咨询表单提交。

响应目标
工作日 2 个工作日内确认收到;修复时限根据复现结果和服务范围另行确认。

范围
免费支持覆盖下载完整性、文档错误和可复现的 Skill 缺陷;项目适配、代操作和持续运维属于单独服务。

版本记录

v1.0.0
  • 从 YW1975/margay-team-share 的提交 2ab685569c74c7f65208607582e78274972ff1f2 导入规范包。
  • 补充双语目录文档、使用示例、来源信息和独立语义化版本记录。

安装与校验

发布与下载

下载已经验证的正式版本

v1.0.0

制品通过受控下载接口从私有存储交付。解压前请核对校验值,安装前请检查包内许可证和 SKILL.md。

文件
api-contract-verifier-1.0.0.zip
大小
44.5 KB
SHA-256
7dfd8ce7ab72126f6c9ed493eb8726d6b89c8260aea631d5bf695f9f070589cc