OpenAPI(Swagger)検証ツール
OpenAPI/Swagger定義ファイル(YAML/JSON)の構文とスキーマを検証します。
OpenAPI 3.0/3.1またはSwagger 2.0形式の定義を入力してください
このツールの使い方
- 使用しているOpenAPIのバージョンを選択します(3.0/3.1または2.0)。
- 入力形式(YAMLまたはJSON)を選択します。
- テキストエリアにOpenAPI/Swagger定義を入力します。
- 「検証を実行」ボタンを押すと、検証結果が表示されます。
- 初めての方は「サンプルを読み込む」ボタンで使い方を確認できます。
特徴
- ブラウザ内完結:入力データはサーバーに送信されません。
- 複数バージョン対応:OpenAPI 3.0/3.1とSwagger 2.0に対応。
- YAML/JSON両対応:どちらの形式でも検証可能。
- 詳細なエラー表示:エラーの位置と内容を分かりやすく表示。
- 構造チェック:必須フィールドや構造の妥当性を検証。
- レスポンシブ対応:スマホ・タブレットでも快適に操作できます。
- 完全無料:登録不要で今すぐ使えます。
OpenAPI/Swaggerとは
OpenAPI Specification(旧Swagger)は、RESTful APIを記述するための標準仕様です。 API設計、ドキュメント生成、コード生成、テストなどに活用されます。
主な検証項目
- 必須フィールド: openapi/swagger, info, pathsなど
- 構造の妥当性: ネストされたオブジェクトの構造
- データ型: 各フィールドの型チェック
- 参照の整合性: $refの参照先が存在するか
- HTTPメソッド: 有効なHTTPメソッドの使用
- レスポンスコード: 有効なHTTPステータスコード
OpenAPI 3.0とSwagger 2.0の違い
OpenAPI 3.0/3.1:
- より柔軟なサーバー定義(servers)
- 複数のリクエスト/レスポンスボディに対応
- コンポーネントの再利用性向上
- より詳細なセキュリティ定義
Swagger 2.0:
- シンプルな構造
- host、basePath、schemesでサーバー定義
- definitionsでモデル定義
注意点
- 入力内容はブラウザ上でのみ処理され、サーバーには保存されません。
- このツールは基本的な構造とスキーマの検証を行います。
- 非常に大きなファイルの場合、処理に時間がかかることがあります。
- 参照($ref)の検証は同一ファイル内のみ対応しています。
- 完全な仕様準拠を保証するものではありません。本番前には公式ツールでの検証を推奨します。