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
調べ合致性
操作、入力、反応、セキュリティ、スケジュールの変更を検証し、証拠の前と後。
03
リリース計画
マークは例外を検討し、変数ログ、監査データまたはCIの決定を輸出した。

よくある質問

API契約はアップされますか?

パルシング、標準化、比較、輸出はこのブラウザで実行されます。

どのような契約が支持されているのか。

OpenAPI 3.x、一般的なAsyncAPI 2 および 3 構造、および GraphQL SDL がサポートされています。

契約試験を置き換えるのか?

静的な契約比較は早期レビュー層であり、実行時間の確認と消費テストは依然として必要です。

外部の参照は有効ですか?

現地構成要素の参照は、サポートされている場所で解決され、遠隔参照がレビューの限界として報告されます。

ほかの用途特化型ブラウザツールもお試しください。

すべてのツール

使い方

両方の契約を締結

調べ合致性

リリース計画

よくある質問

関連ツール

OpenAPI エディタ＆契約テスター

GraphQL クエリ＆スキーマエクスプローラ

AsyncAPI エディタ & バリデーター