OpenAPI 2.0(Swagger)の定義は読まない
swagger: "2.0" と書かれた古い形式の定義の例です。2.0 は本文も parameters に書くなど規則が違うため、誤りとして示して出力は出さないことを確かめます。
入力
OpenAPI の定義(JSON)
{"swagger":"2.0","paths":{"/a":{"get":{}}}}
結果
エラー 1 件・警告 0 件・情報 0 件
指摘(エラー・警告・情報)
- エラー swagger swagger: "2.0" は OpenAPI 2.0(Swagger)の定義です。2.0 では本文も parameters に書くなど規則が違うため、このツールは 3.x だけを読みます。
必須パラメータの一覧
出力はありません(指摘の一覧をご覧ください)。
検算(この結果になる理由)
swagger の項目は OpenAPI 2.0 の定義を表します。このツールは Parameter Object の規則を 3.1.0 で確認したものなので、2.0 は対象外として誤りが 1 件になり、出力はなしです。
判定の根拠は仕様と根拠に、仕様の出典とともにまとめています。自分の入力で試すにはツールをお使いください。
このツールの制約
- YAML 形式、外部ファイルや URL への参照は読めません。同じファイル内の #/… の参照だけ解決します。
- リクエスト本文(requestBody)の必須や、認証(security)の要件は含めません。パラメータの一覧です。
- OpenAPI 2.0(Swagger)の定義は対象外です。仕様の確認は 3.1.0 で行ったもので、3.0 系の細部の違いまでは確かめていません。
- OpenAPI 全体の文法や、パラメータの schema(型・形式)の正しさは検査しません。
ご利用にあたって
- 一覧は貼り付けた定義の内容にもとづきます。実際の API サーバーの挙動とは異なることがあります。
- 大きな定義はお使いの端末の性能によって処理に時間がかかることがあります。