OpenAPI バリデーター
OpenAPI仕様(OAS 3.0/3.1)のYAML/JSONをブラウザ内でバリデーションできる無料のオンラインツールです。必須フィールドの欠落・パス形式の誤り・HTTPメソッドの不正などの構造エラーをエラー・警告・情報の3段階の重要度で分類して表示します。定義されたAPIエンドポイントはタグ別のツリービューで一覧表示され、API仕様の全体像を素早く把握できます。ファイルアップロードにも対応しており、外部へのデータ送信は一切ありません。
最終更新:
使い方
使い方を開く使い方を閉じる
- 1
OpenAPI仕様を入力
YAML/JSON形式のOpenAPI仕様をテキストエリアに貼り付けるか、ファイルをアップロードします。サンプルプリセットも用意しています。
- 2
バリデーション結果を確認
入力と同時にリアルタイムでバリデーションが実行され、エラー・警告・情報が重要度別に表示されます。
- 3
エンドポイントを確認
定義されたAPIエンドポイントがタグ別のツリービューで表示されます。メソッド、パス、概要を一覧で確認できます。
OpenAPI仕様
バリデーション結果
OpenAPI仕様を入力してください
OpenAPI バリデーターとは
OpenAPI バリデーターは、OpenAPI仕様(OAS 3.0/3.1)に基づいてAPI定義ファイルの妥当性を検証するオンラインツールです。YAML/JSON形式の入力を自動検出し、必須フィールドの存在確認・パス形式の検証・HTTPメソッドの妥当性確認などの構造検証を行います。問題点はエラー・警告・情報の3段階で分類され、ファイルのパスと行番号付きで表示されるため修正箇所を特定しやすくなっています。定義されたAPIエンドポイントはタグ別のツリービューで一覧表示され、API設計の俯瞰確認にも役立ちます。.yaml/.yml/.jsonファイルのアップロードにも対応しています。
主な機能
- OpenAPI 3.0/3.1のYAML/JSON入力に対応(自動検出)
- 構造バリデーション(必須フィールド、パス形式、HTTPメソッド)
- エンドポイント一覧のツリービュー表示(タグ別グループ化)
- エラー・警告・情報の3段階で問題を分類
- ファイルアップロード対応(.yaml/.yml/.json)
- 外部サーバーへの送信なしでブラウザ内処理
こんな場面で役立ちます
- API定義ファイルをコミット前に構造チェックしたいとき
- OpenAPIスキーマの記述ミスを素早く発見したいとき
- APIのエンドポイント一覧を俯瞰的に確認したいとき
- CI/CDパイプラインに入る前に手動でバリデーションしたいとき
よくある質問
Swagger 2.0はサポートしていますか?
現在はOpenAPI 3.0/3.1のみサポートしています。Swagger 2.0の入力を検出した場合はエラーメッセージで通知します。
データは外部に送信されますか?
いいえ、処理はブラウザ内のJavaScriptで行われます。入力データが外部に送信されることはありません。
$refの参照解決はできますか?
現在は$refの形式チェックのみ行います。外部ファイル参照の解決には対応していません。
カスタム拡張(x-で始まるキー)はどう扱われますか?
OpenAPI仕様に準拠したx-接頭辞の拡張フィールドは警告なしで許可されます。これはOpenAPI仕様がベンダー拡張として認めている機能であり、特定のツールやフレームワーク向けのメタデータを追加する際に使用されます。
OpenAPI仕様とSwagger仕様の関係は?
SwaggerはOpenAPI仕様の前身であり、Swagger 2.0はのちにOpenAPI 2.0として再定義されました。現在「OpenAPI」といえば一般的にOpenAPI 3.x(3.0または3.1)を指します。このバリデーターはOpenAPI 3.0/3.1のみをサポートしており、Swagger 2.0の仕様を入力した場合はエラーメッセージで案内されます。
