OpenAPI エクスプローラー

OpenAPI または Swagger の JSON/YAML 定義内の操作を参照し、リクエストフィールドに入力して、リクエストを送信せずに cURL または Fetch スニペットを生成します。

ブラウザ内でローカルに実行
API 定義

OpenAPI 3.x または Swagger 2.0 のドキュメントを JSON または YAML で貼り付けてください。このツールがアップロードまたは取得することは一切ありません。

利用可能な操作
定義を解析してエンドポイントを参照します。
リクエストビルダー

上のエンドポイントを選択すると、パス、クエリ、ヘッダー、本文のフィールドが作成されます。

Select an endpoint to generate a cURL command.
Select an endpoint to generate Fetch code.

API 仕様をどこにも送信せずに探索

OpenAPI Explorer はローカルの JSON または YAML を読み込み、エンドポイントと必須入力を表示し、自分の API クライアントで使用する前に調整できるリクエストスニペットを作成します。リクエスト、トークン、仕様を他のサービスに意図的に送信することはありません。

定義からリクエストを組み立てるには

OpenAPI 3.x または Swagger 2.0 の定義を貼り付けると、宣言されている操作を一覧し、記載されたパラメーターを入力して、選んだエンドポイントの cURL または Fetch のコードをコピーできます。

定義・サーバー URL・Bearer トークンはブラウザー内にとどまります。ドキュメントはローカルで解析され、このページから API へリクエストを送信することはありません。

  1. 定義を JSON または YAML でエディターに貼り付けるか、Load example でサンプルから始めます。
  2. Analyze definition を押します。操作一覧にメソッドとパスが表示されます。バージョンの記載がない場合や paths に操作がない場合は、その旨がステータス行に表示されます。
  3. 操作を選ぶと、定義に基づいてパラメーター欄が作られます。パス・クエリ・ヘッダーの各項目に加え、定義に本文の記載があればリクエスト本文の欄も現れます。
  4. 必須項目を入力します。記載されたパラメーターがすべて揃うまでコードは生成されず、不足している最初の項目がステータス行に示されます。
  5. Generate request code を押し、Copy cURL または Copy Fetch でコピーします。エンドポイントが要求する場合は、先にサーバー URL や Bearer トークンを設定してください。

このビルダーが行うこと・行わないこと

対応する定義

OpenAPI 3.x と Swagger 2.0 に対応し、JSON と YAML のどちらでも読み取ります。どちらの記載もないドキュメントは拒否され、不足しているルート項目がメッセージで示されます。

操作の一覧は paths オブジェクトから作られます。メソッドごとに 1 行、パスと操作の概要が付き、概要がない場合は「No summary provided」と表示されます。

生成されるコードは出発点です

KivTools は定義からリクエストを書き出すだけで、実行はしません。このページから API へ何も送信されないため、入力したトークンはコードの文字列を埋めるためだけに使われます。

生成されたコードには、定義に記載されたパラメーターとヘッダーが含まれます。記載のない要素(再試行、署名、ページング、OAuth フローなど)は、お使いのクライアント側で追加してください。

よくある質問

このツールは API を呼び出しますか?

いいえ。定義を読み取ってリクエストのコードを書き出すだけで、リクエストは実行されません。このページから API へ通信が届くことはありません。

対応している定義形式は?

OpenAPI 3.x と Swagger 2.0 で、JSON または YAML で記述されたものです。ドキュメント先頭のバージョン記載によって各項目の解釈が決まります。

最近使ったツール: