Skip to content

Roqueman API Client

Roqueman は RoqueOS の API クライアントです — Web デスクトップ内で動く Postman/Insomnia のようなものです。HTTPWebSocketGraphQL リクエストを作成して送信し、すべてをコレクションで整理し、変数と環境を使い、テストスクリプトを書き、レスポンス連携コレクションランナーでフローを自動化できます — インストール不要です。

Roqueman

何が便利か

すでに作業している場所で API をテストでき、データはアカウントに同期されます。別アプリも追加ログインも不要 — Launchpad から Roqueman を開くだけです。

管理者:サーバーコレクションを自動で

サーバーに接続した管理者には、RoqueOS Server コレクション(サーバー API の全エンドポイント)が自動で読み込まれ、アクティブなサーバーを指す環境も用意されます — そのまま実行できます。


実行モード

各リクエストは 3 つのモードのいずれか(URL の隣のセレクター)で実行され、状況に応じて CORS を回避します:

  • ブラウザ (Axios) — ブラウザから直接送信。CORS が有効な公開 API に最適。ファイルアップロードに必要なモードです(ブラウザが multipart/boundary を生成します)。
  • サーバー (Proxy) — RoqueOS Server 経由で転送(Server Mode の接続が必要)。サーバー側で CORS を解決します。
  • 関数 (Proxy) — RoqueOS の Cloud Function 経由で転送(デフォルト)。自前のサーバーなしで CORS を解決します。

各リクエストにはタイムアウト(デフォルト 30 秒)があります。遅いエンドポイントでアプリが固まることはなくなり、手動キャンセルとは区別されたタイムアウト通知が表示されます。


リクエストの作成

  • メソッド + URL: GET、POST、PUT、PATCH、DELETE、HEAD、OPTIONS。
  • Params: クエリ文字列のキー/値テーブル(行ごとのオン/オフ付き)。
  • Headers: キー/値テーブル。
  • Body:
    • JSON / XML / Text — シンタックスハイライト付きエディター。
    • Form (urlencoded) — キー/値テーブル。
    • Multipart (form-data) — 各行がテキストファイルを切り替え(ファイル選択付き)。実際のファイルアップロードにはブラウザモードが必要です。
    • Binary — 生のファイルをその content-type で送信します。
  • Auth: なし、Bearer、Basic、API Key(header/query)、OAuth 2.0、Digest。
  • スクリプト: pre-request と post-response(Postman 互換の pm API — pm.environment.setpm.testpm.expect など)。

OAuth 2.0 — トークンを自動取得

Auth → OAuth 2.0 → 詳細設定Token URLClient ID/SecretScope を入力し、トークンを取得をクリックします。Roqueman は client credentials でトークンを取得し(タブの実行モードを使うのでプロキシが CORS を解決します)、Access Token を自動的に入力します。


変数と環境

任意のフィールド(URL、headers、params、body、auth)で を使えます。解決順序は グローバル → コレクション変数 → アクティブな環境 → ランタイム(スクリプト) です。 などの動的変数もあります。

送信前に、未解決の があると Roqueman が(ブロックせずに)警告します — が空文字として黙って送られることを防ぎます。

環境は上部のセレクター(歯車)から管理します — 作成、編集、複製、インポート/エクスポート、アクティブ環境の切り替え。

レスポンス → 変数の連携

抽出タブで、レスポンスの値を次のリクエスト用に変数へ保存するルールを定義できます — スクリプトを書かずに:

  • 取得元: Body(JSON パス、例: data.token)、Header(名前)、Status。
  • 保存先変数 + スコープ(Environment または Global)。

成功レスポンスのたびに値が抽出・保存されます(「変数を保存しました」トースト)。これにより、たとえばログインして返ってきたトークンを後続リクエストで自動的に使えます。


コレクションとランナー

リクエストをネストしたフォルダーを持つコレクションに整理します。保存・複製・移動・インポート/エクスポート(Postman v2.1 形式、cURL、RoqueOS)。

コレクションのコンテキストメニューのコレクションを実行でランナーが開きます: すべてのリクエストを順番に(ルートとフォルダー)実行し、テストスクリプトを走らせ、リクエストごとの結果(ステータス、時間、テスト ✓/✕)と合否のサマリーをライブ表示します。レスポンス→変数の連携はランナー内でも動作するため、リクエスト間に依存があるフローも最初から最後まで実行できます。


レスポンス

ビューアは ステータス・時間・サイズ を表示し、Body(ハイライトと生表示)、HeadersCookiesTests(post-response スクリプトの結果)のタブがあります。リクエストを コピーダウンロードし、9 言語(cURL、Fetch、Axios、Python、PHP、Go、Java、C#、Ruby)でコードを生成できます。


WebSocket と GraphQL

タブの隣の + ボタンで WebSocket または GraphQL タブを作成します:

  • WebSocket: 接続して、テキスト/JSON を送信し、メッセージログを確認します。自動再接続がオン(デフォルト)だと、予期しない切断で指数バックオフによる再接続が行われます — 手動切断では再接続しません。
  • GraphQL: query エディター + 変数 + スキーマのイントロスペクション。

タブと履歴

  • 複数リクエストのタブ(「未保存」状態あり)。開いているタブと下書きはリロードしても保持されます(作業が失われません)。
  • 送信したリクエストの履歴(日付ごとにグループ化、検索・再実行可能)。

FAQ

ファイルアップロードが動きません。 実行モードをブラウザ (Axios) に切り替えてください — 本物の multipart/form-data を生成できるのはこのモードだけです。サーバー/関数プロキシはファイルアップロードを転送しません。

データはどこに保存されますか? コレクション、リクエスト、環境、グローバル、履歴はアカウント(Firebase)に保存され、デバイス間で同期されます。開いているタブはローカルのブラウザに残ります。

環境変数は秘密ですか? アカウントにテキストとして保存されます。機密性の高い本番のシークレットを共有環境に置かないでください。

「タイムアウト」と表示されました。 リクエストが 30 秒を超えました。エンドポイント、ネットワーク、または実行モードを確認してください。