01
バージョンによる違いを確認する
openapiまたはswaggerのルートフィールドで適用する規則が決まります。3.1ではcomponentsだけの文書も有効になり得るため、端点がゼロでも即エラーにはしません。
- サンプルには共有パラメータと再帰モデルが含まれます。
APIツール
OpenAPIフォーマッター仕様の構造を確かめる
JSONまたはYAMLの仕様を入力して、操作と参照を確認し、必要な形式で出力します。
OpenAPIフォーマッター
OpenAPI仕様の入力
結果
一致するリクエストエンドポイントはありません。
0件中0件を表示
仕様はこのブラウザ内で処理します。APIリクエストの送信や外部参照の取得は行いません。
出力設定
仕様の構造と主なパス規則を検証します。端点出力はpathsのみで、webhookとcallbackは除きます。サンプル値や実際の応答は検証しません。
入力50万文字・深さ60・5万ノード・診断100件まで。検証時間は5秒です。
仕様を入力するかサンプルを読み込んでください。
選択中の表示内容をコピー・保存します。端点一覧は検索に関係なく全件出力します。
OpenAPIフォーマッターは、生成された長い仕様をレビューするときに役立ちます。インデントを整えるだけでなく、レスポンス定義の不足やパスパラメータの宣言漏れを操作の一覧と照らし合わせられます。
まず仕様のバージョンを確認してください。整形は表記を変える処理であり、実際のAPIが正しい応答を返すかどうかのテストとは別です。
OpenAPIフォーマッターを使う理由
仕様全体の問題を、影響する操作に結び付けます。
パスから必要な定義へ進む
OpenAPIフォーマッターはリクエストのパスごとに操作をまとめます。展開すると共有パラメータ、本文、応答コード、サーバー、安全性の宣言を確認できます。検索しても出力する一覧は全件のままです。
参照先が未確認ならそのまま伝える
同じ文書内のJSON Pointerを調べ、参照先がなければエラーにします。再帰モデルはリンクを保ち、無限に展開しません。外部ファイルへの参照は未検証と表示して、確認済みの項目と混同させません。
出力前に確認したい三つのポイント
02
継承後のパラメータを見る
操作を展開し、名前・配置・必須指定を確認します。操作側に同じ名前と配置のパラメータがあれば、パス側の定義を上書きします。
- 自動検証を切るとCtrl/Cmd + Enterで実行できます。
03
用途に合わせて表示を選ぶ
整形済み仕様は編集用、端点一覧は全操作のJSON出力、Markdownはレビュー用の文書です。検索条件は一覧の書き出しには適用されません。
- 入力や出力設定を変更すると、再検証が終わるまで保存できません。
整形からパラメータの確認まで
バージョン別のOpenAPI検証
Swagger 2.0とOpenAPI 3.0・3.1に対応する文書スキーマで構造を検証します。3.1内の標準JSON Schema 2020-12キーワードも確認し、不正な型名や操作の必須フィールド不足を検出します。
操作とパステンプレートの整合性
操作IDの重複、同一リストの重複パラメータ、未宣言または任意扱いのパスパラメータを診断します。serversやparametersをHTTP操作として数えることはありません。
Swaggerの整形と形式変換
インデントはスペース2個または4個です。YAMLからJSONへの変換も、その逆もできます。元のバージョンと参照文字列は維持され、移行処理は行いません。
レビュー向けのMarkdown
API情報、サーバー、操作ごとのパラメータ、リクエスト本文、応答定義をまとめます。説明文はエスケープし、コードブロックを安全に囲みます。画面でHTMLを実行しません。
対応範囲と入力の制限
- 一つの文書を扱う
- 対応はSwagger 2.0とOpenAPI 3.0.x・3.1.xです。3.2や別系統の仕様は拒否します。ローカル参照はこの文書の内部を意味し、別ファイルを読み込む機能ではありません。
- 高度な参照は未検証として残す
- 外部URLや相対ファイルを取得しません。リソースID、アンカー、動的参照、独自方言には未検証の警告が付きます。依存先を調べる場合は信頼できる環境で文書をまとめてください。
- 値と表記を区別する
- YAMLのコメントや引用符の書き方は出力に残りません。単一のYAML 1.2文書と文字列キーを使用してください。アンカー・別名・マージ・独自タグ、重複キー、精度を失う数値は拒否します。
- 端点一覧はpathsが対象
- Webhookとcallbackは構造のみ検証し、一覧やパスの意味検証には含めません。サンプル値、実際の応答、認証、業務上の動作には別のテストが必要です。
- 処理量に上限がある
- 入力50万文字、深さ60、5万ノードまでです。診断100件、結果200万文字、検証5秒のいずれかを超えると処理を停止します。大きな仕様は分けて確認してください。
OpenAPIフォーマッターのよくある質問
JSONとYAMLの両方を扱えますか？
はい。入力形式と出力形式は別々に選べます。YAMLでは状態コードなどのキーも文字列で記述してください。整形後の値は同じでもコメントや引用符のスタイルは変わります。
OpenAPIスキーマに対して完全に検証しますか？
文書スキーマ、標準キーワード、ローカル参照、主なパス規則を確認します。外部参照や独自方言は未検証と表示し、実際の応答やサンプル値の正しさまでは判断しません。
どのバージョンを認識しますか？
Swagger 2.0、OpenAPI 3.0.xと3.1.xを検証します。3.2など対応外のバージョンは明示的に拒否し、別バージョンの規則を当てはめません。
API仕様はアップロードされますか？
いいえ。解析と検証はブラウザのワーカー内で行います。仕様に含まれるURLにもアクセスしません。再読み込み時に入力を復元する保存機能はありません。
整形した結果をダウンロードできますか？
はい。整形済み仕様はJSONまたはYAML、端点一覧は全件のJSON、文書はMarkdownで保存できます。エラーや古い結果があるときは出力を無効にします。
期待と違う結果になりましたか？