コンテンツにスキップ

記録セッション

記録セッションは、Web ページを操作している間そのページを観察し、行われるすべての API 呼び出し(REST、GraphQL、gRPC-web、WebSocket)を書き留めます。キャプチャした呼び出しは通常のレスポンスと同じように閲覧でき、Pro および Enterprise プランでは、ページが実際に送信した内容をあらかじめ入力した本物の再実行できるリクエストのフォルダーに変わります。

フロントエンドしか手元にない API をドキュメント化するための最短経路です。設定するプロキシも、インストールする証明書も、ブラウザー拡張機能も必要ありません。

セッションはツリー内のどこでも(ルート、フォルダー、環境フォルダーのいずれでも)、コンテキストメニュー(「追加」→「記録セッション」)または「作成」メニューから作成できます。シナリオだけはセッションを含められません。サイドバーには親ノードとして表示され、セッション自体をクリックすると設定ページが開き、その子行はそれぞれ専用のタブを開きます。

記録セッションの設定ページ:ページの url、記録するプロトコル、ホワイトリストとブラックリスト、そして「記録を開始」ボタン

設定は次の 4 つの要素で構成されます。

  • ミニブラウザーで開くページの url(http://、https://、または file://)。url が有効になるまで「記録を開始」ボタンは無効のままです。
  • 記録するプロトコル:HTTP、WebSocket、GraphQL、gRPC-web — 既定ではすべてチェックされています。
  • ホワイトリスト:正規表現のリストです。少なくとも 1 つに一致する呼び出しが保持されます。空の場合はすべてを通します。
  • ブラックリスト:正規表現のリストです。いずれかに一致する呼び出しは除外されます。ブラックリストが常に最終的な判断権を持ちます。

プロジェクトファイルに保存されるのは、これらの設定と推定されたルートだけです。キャプチャした呼び出しはメモリ上に留まり、プロジェクトを閉じると消え、ディスクに書き込まれることはありません。

「記録を開始」ボタンはミニブラウザーのタブでページを開き、最初の読み込みの前にレコーダーを接続します。そのため、ページの起動時に行われる呼び出し(すぐに開かれる WebSocket 接続を含む)もキャプチャされます。サイドバーのセッションのバッジとそのタブの周囲に表示される脈動する光が、記録が実行中であることを示します。

記録中のミニブラウザー:サイトのページ、アドレスバー上の「記録を一時停止」と「記録を停止」ボタン、セッションに付いた赤いバッジ

ページを通常どおり閲覧し、操作してください。アドレスバー上の 2 つのボタンでセッションを制御します。

  • 記録を一時停止は、ページを開いたままにしつつ呼び出しの保存を止めます — 関心のない画面を通過するときに便利です。
  • 記録を停止は、レコーダーを切り離してブラウザーのタブを閉じます。キャプチャはそのまま利用できます。

記録は常に明示的な操作です。アプリケーションの再起動時に復元されたブラウザータブは何も記録しません。

位置情報を必要とするサイトはブラウザーにそれを要求しますが、既定ではミニブラウザーは何も開示しません。アプリケーション設定のプライバシーセクションにある 埋め込みブラウザと位置情報を共有する 設定(既定ではオフ)は、同意を求めたうえで、おおよその位置を提供します。位置情報はシステムの位置情報サービスから取得され、利用できない場合は IP アドレスに基づく都市レベルの推定値が使われます。オフにすると、位置情報は直ちに破棄されます。

セッションの「キャプチャ」行を開くと、実行ごとに古いものから新しいものへグループ化され、記録中はリアルタイムで更新される呼び出しの一覧が表示されます。一覧を最下部までスクロールしている間は、最新の呼び出しに追従します。上にスクロールして呼び出しを読むと、一覧はその位置に留まります。フィルターフィールドで一覧を絞り込めます。呼び出しの詳細には、リクエストのレスポンスタブ(本文、情報、Cookie、グラフ)がプロトコルごとにそのまま再利用されます。

キャプチャビュー:左に実行ごとにグループ化された呼び出しの一覧、右に選択した呼び出しの詳細とそのレスポンスタブ

呼び出しのコンテキストメニューには「ホワイトリストに追加…」と「ブラックリストに追加…」があり、その url がパターンとしてあらかじめ入力されます。新しいパターンをすでにキャプチャした呼び出しに適用することもできます。通過しなくなった呼び出しは完全に削除されるため、アプリケーションが確認を求めます。

セッションごとに保持される呼び出しの数には上限があります(既定で 1,000 件、アプリケーションの設定で調整できます)。上限を超えると、最も古いものから削除されます。

Pro および Enterprise プランでは、キャプチャビューのルートを推定ボタンが呼び出しをセッションの「ルート」行の下のツリーに変換します。

  • 呼び出しはルートごとにグループ化されます。呼び出しごとに変わるパスセグメント(/pets/1、/pets/2)はパスパラメーター {{petId}} になります。
  • フォルダーはパスの静的なプレフィックス(api › pets)に従います。gRPC-web の呼び出しはサービスごとに整理されます。
  • 各ルートは通常のリクエスト(HTTP、GraphQL、gRPC-web、または WebSocket)になり、最後に成功した呼び出しの内容(ヘッダー、パラメーター、本文)があらかじめ入力され、すぐに再実行できます。
  • キャプチャした呼び出しは、通常の形式で、設定された保持上限の範囲内で、各リクエストのレスポンス履歴に書き込まれます。既定で表示されるレスポンスは、最後に成功した呼び出しのものです。

展開されたセッションの「ルート」行:推定されたフォルダーとそのリクエストが、再実行できる状態で並んでいる

新たな記録の後に推定を再実行すると、結果はマージされます。追加されるのは新しいルートだけで、既存のリクエスト(編集したものを含む)はそのまま保たれます。

Community プランでも、記録とキャプチャの閲覧は完全に利用できます。「ルート」タブには Pro 機能であることを知らせる案内が表示されます。

この機能はすべて Restorm の MCP サーバーから利用できます。セッションの作成と設定、記録の開始と停止、キャプチャの読み取り、ルートの推定です。エージェントはページを開いて動かしたまま待ち、すぐに使えるリクエストのフォルダーを届けることができます。