仕様と根拠

必須になる条件

OpenAPI 3.1.0 の Parameter Object では、in が path のパラメータは required: true が必須で、ほかの場所(query・header・cookie)は required が省略されると false になります。このツールは、required: true のものと path のものを必須として挙げます。name は大文字小文字を区別します。

Path Item と Operation の統合

Path Item Object の parameters は、そのパスのすべてのオペレーションに共通で、Operation 側で上書きできますが削除はできません。上書きは name と in の組み合わせが同じものに対して行われ、Operation の定義が優先されます。したがって Operation で required: false に上書きされた共通パラメータは必須から外れます。

参照と無視されるヘッダー

パラメータは $ref(Reference Object)で components の定義を参照できます。このツールは同じファイル内の #/… の参照を、最大 10 段まで解決します。Accept・Content-Type・Authorization のヘッダーのパラメータは、仕様により無視されるため一覧に入れません。

根拠にした仕様・資料

指摘の段階

• エラー: 仕様に反していて、正しく読めない・処理できない入力です。
• 警告: 読めるものの、仕様の推奨に反する・矛盾する・意図と違う結果になりやすい入力です。
• 情報: 誤りではありませんが、知っておくとよい扱い(読み飛ばした部分や解釈)です。

入力の扱い(送信しない仕組み)

処理はすべてお使いのブラウザの中で行います。処理の本体はこのサイトから配信する小さなスクリプト(/app.js)で、外部のサービスやライブラリを読み込みません。ページはブラウザに通信を禁止させる設定(Content-Security-Policy の connect-src)つきで配信しており、入力した内容がサーバーや第三者へ送られることはありません。ファイルを選んだ場合も、端末の中で読み込むだけです。

このツールでできないこと(制約)

• YAML 形式、外部ファイルや URL への参照は読めません。同じファイル内の #/… の参照だけ解決します。
• リクエスト本文(requestBody)の必須や、認証(security)の要件は含めません。パラメータの一覧です。
• OpenAPI 2.0(Swagger)の定義は対象外です。仕様の確認は 3.1.0 で行ったもので、3.0 系の細部の違いまでは確かめていません。
• OpenAPI 全体の文法や、パラメータの schema(型・形式)の正しさは検査しません。