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