OpenAPI Viewer

使い方

1. 左パネルにドキュメントを貼り付けます —— JSON でも YAML でも受け付けます。
2. ドキュメントを解析を押すと、右パネルに要約が入ります。タイトル・バージョン・サーバー、続いて各パス。
3. 各操作の行には、メソッド・パス・概要・パラメータ（位置と必須かどうか）・リクエストボディのコンテンツタイプ・レスポンスコードと 1 レベルのスキーマ型要約が並びます。
4. ドキュメントが不正な場合、エラー行にどのフィールドが足りないか・どこが解析失敗したかが出ます。
5. 要約をコピーまたはダウンロードして、チケット・レビュー・README に貼れます。

よくある用途

• 実装前の仕様確認 —— エディタを開かずに全エンドポイント・入力・出力を読む。
• API 概要の共有 —— ドキュメント全体ではなく要約をチャットやチケットに。
• 生成された仕様の点検 —— パス・パラメータ・レスポンスコードが期待通りか確認。
• OpenAPI の構造学習 —— info・servers・paths・components の組み立てを実例で確認。

よくある質問

Q: 対応バージョンは？ A: OpenAPI 3.x と Swagger 2.0 です。バージョンフィールドは必須で、欠けている場合はその旨がエラーに出ます。

Q: スキーマ要約の深さは？ A: 1 レベルです。オブジェクトのプロパティは名前と型で列挙され、ネストしたオブジェクトは参照名または短い型注釈として出ます。完全なスキーマブラウザではなく、API の地図です。

Q: $ref ポインタはどう表示されますか？ A: 参照先の名前で表示されます（例 ref:Book）。components への解決は行わないため、要約は読みやすいままです。

Q: YAML の解析に失敗しました。 A: エラー行に js-yaml のメッセージが含まれ、大抵は問題の行を指します。インデントのタブと閉じ忘れた引用符が典型的な原因です。