API 契约差异检查器

私密多契约审查

在本地比较 OpenAPI、AsyncAPI 或 GraphQL 版本并解释破坏性变更。

契约格式

基线契约

最近一次已发布或已接受的契约。

当前契约

准备审查的候选契约。

openapi: 3.1.0
info: { title: Pet API, version: 2.0.0 }
paths:
  /pets/{id}:
    get:
      summary: Get one pet
      security: [{ bearerAuth: [] }]
      parameters:
        - { name: id, in: path, required: true, schema: { type: integer } }
        - { name: locale, in: query, required: true, schema: { type: string } }
      responses:
        '200':
          description: Pet
          content: { application/json: { schema: { $ref: '#/components/schemas/Pet' } } }
  /pets:
    post:
      requestBody:
        required: true
        content: { application/json: { schema: { $ref: '#/components/schemas/PetInput' } } }
      responses: { '201': { description: Created } }
components:
  securitySchemes: { bearerAuth: { type: http, scheme: bearer } }
  schemas:
    Pet:
      type: object
      required: [id, name]
      properties: { id: { type: string }, name: { type: string }, status: { type: string, enum: [active, pending] } }
    PetInput:
      type: object
      required: [name]
      properties: { name: { type: string } }

使用方法

01
载入两份契约
粘贴或打开基线与当前 OpenAPI、AsyncAPI 或 GraphQL 契约。
02
复核兼容性
用前后证据检查操作、输入、响应、Security 和 Schema 变化。
03
规划发布
标记已复核例外，再导出 Changelog、审计数据或 CI 决策。

常见问题

API 契约会上传吗？

不会。解析、规范化、比较和导出都在当前浏览器运行。

支持哪些契约？

支持 OpenAPI 3.x、常见 AsyncAPI 2/3 结构与 GraphQL SDL。

能替代契约测试吗？

不能。静态契约比较是早期审查层，仍需运行时验证器与消费者测试。

会抓取外部引用吗？

不会。在支持范围内解析本地组件引用，远程引用会作为复核边界报告。

继续使用其他专注的浏览器端工具。

全部工具

使用方法

载入两份契约

复核兼容性

规划发布

常见问题

相关工具

OpenAPI 编辑器与契约测试器

GraphQL 查询与 Schema 浏览器

AsyncAPI 编辑与验证器