仕様と根拠
判定の順序
OpenAPI 3.1.0 の Responses Object では、キーに 3 桁のコード(200 など)、1XX〜5XX の範囲(X は大文字)、default を書けます。明示のコードが範囲より優先され、default は個別に宣言されていない応答の受け皿です。このツールは、明示のコード、範囲、default、未定義の順に判定します。
パスの照合
観測したパスは、文書の paths のキーと完全に一致するものを先に探し、なければ {id} のようなテンプレート部分を 1 区間の任意の文字に置き換えて照合します。クエリ(? 以降)は無視します。メソッドは大文字小文字を区別せず照合します。
指摘の意味
未定義のコード、文書にない操作、responses がない操作、書き方が仕様と違うキー(小文字の 4xx など)は警告です。default で受けているだけの応答は、誤りではないため情報で知らせます。JSON として読めない文書、コードが 3 桁でない観測、読めない行はエラーです。
根拠にした仕様・資料
| 仕様・資料 | 確認日 | 使った箇所 |
|---|---|---|
| OpenAPI Specification v3.1.0 Responses Object | 2026年10月28日 | コードのキー(3 桁・1XX〜5XX・default)と、明示のコードが範囲より優先されること |
指摘の段階
- エラー: 仕様に反していて、正しく読めない・処理できない入力です。
- 警告: 読めるものの、仕様の推奨に反する・矛盾する・意図と違う結果になりやすい入力です。
- 情報: 誤りではありませんが、知っておくとよい扱い(読み飛ばした部分や解釈)です。
入力の扱い(送信しない仕組み)
処理はすべてお使いのブラウザの中で行います。処理の本体はこのサイトから配信する小さなスクリプト(/app.js)で、外部のサービスやライブラリを読み込みません。ページはブラウザに通信を禁止させる設定(Content-Security-Policy の connect-src)つきで配信しており、入力した内容がサーバーや第三者へ送られることはありません。ファイルを選んだ場合も、端末の中で読み込むだけです。
このツールでできないこと(制約)
- JSON 形式の文書だけを読みます。YAML は未対応で、先に JSON に変換してください。
- $ref で別の場所を参照する応答の中身は見ません。コードのキーが定義されているかだけを判定します。
- 応答の本文やヘッダーが仕様に合っているかは検査しません。ステータスコードの有無だけです。
- paths の外(webhooks など)や、パスのテンプレートが複数の区間にまたがる指定には対応していません。
ご利用にあたって
- 運用で観測した応答が仕様にないとき、仕様が古いのか実装が想定外なのかは、このツールでは判断できません。開発の担当者と確認してください。