明示のコードと範囲が両方ある
200 と 2XX が同じ操作に並んでいる境界の例です。200 は明示の定義、201 は範囲の定義で受けられることを確かめます。
入力
OpenAPI 文書(JSON)
{"paths":{"/a":{"get":{"responses":{"200":{},"2XX":{}}}}}}観測した応答(1 行に「メソッド パス コード」)
GET /a 200 GET /a 201
結果
エラー 0 件・警告 0 件・情報 0 件
指摘(エラー・警告・情報)
指摘はありません。
| 観測した応答 | 2 件 |
|---|---|
| 定義あり | 2 件 |
| default で受けるもの | 0 件 |
| 未定義 | 0 件 |
判定の一覧
| 行 | 操作 | コード | 判定 |
|---|---|---|---|
| 1 | GET /a | 200 | 定義あり(明示のコード) |
| 2 | GET /a | 201 | 定義あり(範囲 2XX) |
検算(この結果になる理由)
OpenAPI 3.1.0 では明示のコード定義が範囲定義より優先されます。200 は明示の 200 に当たり、201 は明示がないので 2XX の範囲に当たります。どちらも未定義にはなりません。
判定の根拠は仕様と根拠に、仕様の出典とともにまとめています。自分の入力で試すにはツールをお使いください。
このツールの制約
- JSON 形式の文書だけを読みます。YAML は未対応で、先に JSON に変換してください。
- $ref で別の場所を参照する応答の中身は見ません。コードのキーが定義されているかだけを判定します。
- 応答の本文やヘッダーが仕様に合っているかは検査しません。ステータスコードの有無だけです。
- paths の外(webhooks など)や、パスのテンプレートが複数の区間にまたがる指定には対応していません。
ご利用にあたって
- 運用で観測した応答が仕様にないとき、仕様が古いのか実装が想定外なのかは、このツールでは判断できません。開発の担当者と確認してください。