Compare specs
サイドバーから「Compare specs」としてリンクされる専用ページです。URLで2つのOpenAPIドキュメントを取得し、それらの間で何が変わったかを報告します。追加・削除・変更されたエンドポイントを、それぞれBreakingまたはInformationalとしてフラグ付けします。
使い方
サイドバーのCompare specsをクリックし、ベース(旧)スペックのURLと新スペックのURLを貼り付け(新のフィールドには現在読み込まれているスペックがあらかじめ入力されています)、Compareをクリックしてください。両方のドキュメントは、メインビューアが使うのとまったく同じnormalizeDocument()パイプラインを通るため、別に信頼すべきパーサーはありません。
何がBreakingとみなされるか
| Change | Severity |
|---|---|
| エンドポイントの削除 | Breaking |
| 新しい必須パラメータ | Breaking |
| オプショナルなパラメータが必須になった | Breaking |
| リクエストボディが必須になった | Breaking |
| 2xxレスポンスが削除された | Breaking |
| エンドポイントの追加 | Informational |
| パラメータの削除 | Informational |
| 非2xxレスポンスが削除された | Informational |
| 新しいレスポンスステータスがドキュメント化された | Informational |
範囲
これは意図的に浅い比較です。エンドポイントの有無、パラメータの有無・必須かどうか、リクエストボディの必須かどうか、レスポンスステータスコードを比較します。スキーマの形をフィールド単位で差分検出することはしません(例えばプロパティが静かにstringからnumberに変わっても、まだ検出されません)。