OpenAPI バリデーター
YAMLまたはJSON形式のOpenAPI 3.0、3.1、3.2、Swagger 2.0ドキュメントを確認し、エンドポイントとスキーマの概要を取得します。必須フィールド、パスパラメーターに対するパステンプレート、パラメーターの位置、レスポンスコード、重複するoperation ID、すべてのローカル$refを検証し、各問題の場所を示します。
よくある質問
バリデーターでは何を確認しますか?
OpenAPIまたはSwaggerのバージョン、info.titleとinfo.version、パスがスラッシュで始まること、パス内の各{parameter}に対応する必須パスパラメーターがあることとその逆の対応、パラメーター名と位置、レスポンスのステータスコードと説明、パラメーターの重複、operationId値の重複、すべてのローカル$refがドキュメント内の項目を参照していることを確認します。
仕様をJSON Schemaに照らして完全に検証しますか?
いいえ。上記の構造上のルールを確認するため、手書きのドキュメントでよくある間違いを検出できますが、すべてのフィールドを公式のメタスキーマに照らして検証することや、スキーマの内容を確認することはありません。
概要には何が表示されますか?
仕様とAPIのバージョン、タイトル、すべてのエンドポイントについてメソッド、パス、operationId、概要、レスポンスコードを示す表、そしてcomponents.schemas配下のスキーマ名(Swagger 2.0ではdefinitions配下の名前)が表示されます。
外部参照もたどりますか?
いいえ。ほかのファイルやURLへの参照は取得も報告もされません。#で始まる参照のみ、貼り付けたドキュメント内で解決されます。
エラーと警告の違いは何ですか?
エラーは、レスポンスの説明がない、宣言されていないパスパラメーターがあるなど、仕様のルールに違反するものです。警告は、リクエストボディを持つGET操作やoperationIdのないドキュメントなど、許可されていても通常は意図されていない内容を示します。
OpenAPI 3.1では必須項目が変わりますか?
はい。OpenAPI 3.1と3.2では、操作にresponsesオブジェクトが不要になり、パスの代わりにwebhooksやcomponentsを含むドキュメントも認められます。validatorはopenapiフィールドが3.1または3.2で始まる場合、これらのルールを適用します。