広告が嫌いですか? 行く広告なし今日 

OpenAPI / Swagger仕様バリデーター

データ開発者

広告・取り除く？

入力

自動処理

出力

クライアント側

広告・取り除く？

ガイド

OpenAPI / Swagger仕様バリデーター

OpenAPI 3.0、3.1、またはSwagger 2.0仕様を即座に検証します。YAMLまたはJSONを貼り付けると、JSON Pointerパス付きのエラーと警告の構造化リストを取得でき、ドキュメントをきれいに表示するために仕様を整形（pretty-print）できます。

使い方

OpenAPIまたはSwagger仕様を[入力]フィールドに貼り付けます。バリデーターは、YAMLかJSONか、および使用している仕様のバージョンを自動的に検出します。結果には、エンドポイント、スキーマ、エラー、警告の概要が表示されます。各問題にはJSON Pointerパスが含まれているため、問題をすばやく見つけることができます。

特徴

複数バージョン対応 – Swagger 2.0、OpenAPI 3.0.x、およびOpenAPI 3.1.x仕様を検証します
構造検証 – 必須フィールド（info、paths、version）、正しい型、スキーマ構造をチェックします
セマンティック検証 – 重複したoperationId、無効なHTTPメソッド、壊れた$ref参照、パスパラメータの不一致を検出します
エラーパス – すべての問題に正確な場所を示すJSON Pointerパスが含まれています
整形（Pretty-Print） – 仕様をJSONまたはYAMLとして、適切なインデントでクリーンに再フォーマットします
仕様概要 – 即時概要：バージョン、総エンドポイント数、スキーマ数、エラー数、警告数
100% クライアントサイド – API仕様はブラウザから離れることはありません

広告・取り除く？

 よくある質問

Swagger 2.0とOpenAPI 3.0の違いは何ですか？

Swagger 2.0は、SmartBearによって開発された元のAPI仕様形式でした。2015年に仕様がOpenAPI Initiativeに寄贈された際、OpenAPIと改名されました。バージョン3.0では、コールバック、リンク、複数のサーバー、よりクリーンなコンポーネント構造のサポートが向上するなど、大幅な改善が導入されました。これら2つの形式は直接互換性がありません。
OpenAPI仕様でoperationIdをユニークにする必要があるのはなぜですか？

operationIdは、各API操作の一意の識別子として機能します。コードジェネレーターはこれらを使用してクライアントSDKのメソッド名を生成し、ドキュメントツールはこれらをアンカーリンクとして使用し、テストフレームワークはこれらを使用して特定のendpointを参照します。重複したoperationIdは、これらすべてのダウンストリームツールで競合を引き起こします。
JSON Pointerとは何ですか？また、検証エラーパスの読み方を教えてください。

JSON Pointer（RFC 6901）は、JSONドキュメント内の特定の値を識別するための文字列構文です。たとえば、/paths/~1users/get/parameters/0は、GET /users操作の最初のパラメータを指します。〜1はパスセグメント内のフォワードスラッシュをエスケープします。これらのポインターを読むと、仕様のどこで検証エラーが発生しているかが正確にわかります。
OpenAPI仕様はYAMLまたはJSONで記述すべきですか？

どちらの形式も完全にサポートされており、機能的にも同等です。YAMLは、可読性が高くコメントをサポートしているため、手書きの仕様では一般的に好まれます。JSONは、機械生成された仕様やプログラムによる操作に適しています。ほとんどのツールはどちらの形式も受け入れるため、チームが維持しやすい方を選択してください。