GalleonQL とは/インストールと起動
このページでは、GalleonQL がどんなアプリかを紹介し、各 OS(macOS / Windows / Linux)でのインストールと初回起動の手順を説明します。
GalleonQL とは
GalleonQL は、GraphQL に特化したデスクトップ用の API クライアントです。REST 向けの Postman や Insomnia を GraphQL 用に置き換えるイメージのツールで、次のような流れで使います。
- 接続先の GraphQL エンドポイントから スキーマ(型やフィールドの定義)を取り込み、
- 取り込んだスキーマを ドキュメントとして参照しながら、
- クエリを段階的に組み立て、
- 複数の接続先(環境)を 切り替えて送信し、レスポンスを確認する。
add Query / add Child で枝を継ぎ足しながらクエリを育てていく操作モデルが特徴です。必要な枝だけを一段ずつ伸ばして、クエリを育てていきます。
GalleonQL はデスクトップアプリとして動作し、外部のエンドポイントへの HTTP 通信はアプリ本体(デスクトッププロセス)から発行します。そのため、ブラウザの CORS 制限を受けず、ブラウザからは直接アクセスできない社内 API でも、お使いの PC から到達できるものであれば取り込み・送信ができます。
主要な用語(環境・スキーマ・葉と枝・環境変数と GraphQL 変数など)は 主要な用語 にまとめています。操作に入る前に一度目を通しておくと理解がスムーズです。
動作環境
GalleonQL は次の 3 つの OS 向けに配布しています。
| OS | 配布形式の例 |
|---|---|
| macOS | .dmg / .app(アプリケーション) |
| Windows | インストーラ(.msi / .exe)または実行ファイル |
| Linux | .AppImage または .deb |
署名について(重要): macOS 版は Developer ID 証明書で署名し、Apple の公証(notarization)を受けています。そのまま通常どおり起動できます。**Windows 版と Linux 版はコード署名を行っていない(未署名)**ため、初回起動時に OS のセキュリティ機能が警告を表示します。以下の「初回起動」の手順に沿って起動してください。警告は未署名であることに対するもので、手順どおり操作すれば起動できます。
インストール
GalleonQL は公開リポジトリ trimixjp/GalleonQL のリリースページから配布しています。
- リリースページ(Releases)を開きます。
- 最新版のリリースから、お使いの OS に対応する配布物(アセット)をダウンロードします。
- macOS:
.dmgまたは.appを含むアーカイブ - Windows: インストーラ(
.msi/.exe)または実行ファイル - Linux:
.AppImageまたは.deb
- macOS:
- ダウンロードしたファイルを、次の「初回起動」の手順に従って開きます。
各版の変更点は、リリースページのリリースノートを参照してください。
初回起動
macOS は署名・公証済みでそのまま起動できます。Windows と Linux は未署名のため、初回だけ次の操作が必要です(一度許可すれば、2 回目以降は通常どおりダブルクリックで起動できます)。
macOS
署名・公証済みのため、特別な操作は不要です。.dmg を開き、GalleonQL.app をアプリケーションフォルダへドラッグして、ダブルクリックで起動します。
署名を導入する前の古いバージョンをダウンロードした場合は「開発元を確認できないため開けません」と表示されます。その場合はアプリを 右クリック(または Control + クリック)→「開く」 で起動できます。
Windows
Windows では、未署名の実行ファイルを起動しようとすると Microsoft Defender SmartScreen が「Windows によって PC が保護されました」という青い画面を表示することがあります。
- 画面内の 「詳細情報」 をクリックします。
- 表示された 「実行」 ボタンをクリックします。
これで起動できます。ファイルの入手元に心当たりがあること(公開リポジトリのリリースからダウンロードしたものであること)を確認したうえで実行してください。
Linux
Linux では、ダウンロードした .AppImage に実行権限を付けてから起動します。
chmod +x GalleonQL_*.AppImage
./GalleonQL_*.AppImage
- GalleonQL の画面描画には
webkit2gtk-4.1が必要です。起動時にライブラリが見つからないというエラーが出る場合は、お使いのディストリビューションのパッケージマネージャでwebkit2gtk-4.1(ディストリビューションによりパッケージ名が異なります)を導入してください。 .debを使う場合は、ディストリビューション標準の方法でインストールしてください(依存パッケージも併せて導入されます)。
起動後の画面
起動すると、次のような 3 ペイン構成の画面が表示されます。細かな操作は各機能ページで説明します。ここでは全体像だけつかんでください。
- トップの 2 段バー
- 1 段目: 複数の リクエストタブ(
+で新しいタブを追加)と、プロジェクト / 環境のセレクタ、設定(⚙)。 - 2 段目: METHOD(POST / GET など) と、選択中の環境から解決された エンドポイント URL、送信 ボタン、右側ドキュメントパネルの開閉。
- 1 段目: 複数の リクエストタブ(
- 左のレール(細い縦帯): コレクション / 履歴を切り替えるアイコン。
- 探索パネル: プロジェクト・環境・コレクション、およびリクエスト履歴。右端の境界をドラッグすると幅を変えられます(変えた幅は次回起動時も保たれます)。パネル幅に収まらない長い名前は、その行にマウスを載せると全文が表示されます。
- リクエスト / レスポンス: 中央でクエリを組み立て(Query / Auth / Headers / Hooks タブ)、送信結果を確認します。Hooks は送信後の値抽出・検証です(リクエストフック。Pro)。
- ドキュメント(SCHEMA)パネル: 取り込んだスキーマの型カタログ。ここからクエリビルダーへフィールドを追加できます。
表示テーマ(ダーク / ライト / システム)やフォントサイズ、画面レイアウトは設定(⚙)から変更できます。既定はダークテーマです。
登録した環境と最後に選択していた環境、および過去に取り込んだスキーマは自動的に保存され、次回起動時に復元されます。URL やヘッダーを毎回入力し直す必要はありません。
初めて起動したときは、匿名の利用状況を共有いただき機能改善に役立てる「利用分析」へのご協力をお願いする案内が表示されることがあります。どちらを選んでも後から設定でいつでも変更できます。詳しくは 利用分析 を参照してください。
キーボードショートカット
| キー | 動作 |
|---|---|
⌘W(Windows / Linux は Ctrl+W) |
アクティブなリクエストタブを閉じる。タブが 1 枚だけのときは何も起きません(アプリは終了しません)。 |
⌘Q(Windows / Linux は Ctrl+Q) |
1 秒以内に 2 回押すと終了します。1 回目では終了せず、画面下に「もう一度 ⌘Q で終了します」と表示され、次の押下を待ちます。1 秒を過ぎると数え直しになります。 |
⌘W は多くのアプリで「ウィンドウを閉じる」= GalleonQL では終了になりますが、タブを 1 枚閉じるつもりの
押し間違いで作業中の内容をすべて失わないよう、タブを閉じるに割り当てています。終了の ⌘Q を
2 回押しにしているのも同じ理由です。
次のステップ
- まず接続先を用意します。環境の登録・切替 を参照して、エンドポイント URL・認証・ヘッダーを持つ 環境(接続プロファイル) を登録・選択してください。
- 選択中の環境に対して、GraphQL のスキーマを取り込みます。スキーマの取り込み を参照してください。
- 取り込んだスキーマの見方は スキーマドキュメントの参照 を参照してください。
- スキーマからクエリを組み立てる方法は クエリビルダー、組み立てたクエリの送信とレスポンスの見方は クエリの送信とレスポンス を参照してください。
- 送信後にトークンを環境変数へ保存したり、ステータスやボディを検証したりする場合は リクエストフック(値の抽出と検証) を参照してください(Pro)。