GraftQL マニュアル
変更履歴

GalleonQL とは/インストールと起動

このページでは、GalleonQL がどんなアプリかを紹介し、各 OS(macOS / Windows / Linux)でのインストールと初回起動の手順を説明します。

GalleonQL とは

GalleonQL は、GraphQL に特化したデスクトップ用の API クライアントです。REST 向けの Postman や Insomnia を GraphQL 用に置き換えるイメージのツールで、次のような流れで使います。

  1. 接続先の GraphQL エンドポイントから スキーマ(型やフィールドの定義)を取り込み
  2. 取り込んだスキーマを ドキュメントとして参照しながら
  3. クエリを段階的に組み立て
  4. 複数の接続先(環境)を 切り替えて送信し、レスポンスを確認する。

add Query / add Child で枝を継ぎ足しながらクエリを育てていく操作モデルが特徴です。園芸の「接ぎ木(graft)」のように、必要な枝だけを一段ずつ伸ばしてクエリを組み立てます。

GalleonQL はデスクトップアプリとして動作し、外部のエンドポイントへの HTTP 通信はアプリ本体(デスクトッププロセス)から発行します。そのため、ブラウザの CORS 制限を受けず、ブラウザからは直接アクセスできない社内 API でも、お使いの PC から到達できるものであれば取り込み・送信ができます。

主要な用語(環境・スキーマ・葉と枝・環境変数と GraphQL 変数など)は 主要な用語 にまとめています。操作に入る前に一度目を通しておくと理解がスムーズです。

動作環境

GalleonQL は次の 3 つの OS 向けに配布しています。

OS 配布形式の例
macOS .dmg / .app(アプリケーション)
Windows インストーラ(.msi / .exe)または実行ファイル
Linux .AppImage または .deb

署名について(重要): 現在配布しているバイナリは コード署名を行っていません(未署名)。そのため、初回起動時に OS のセキュリティ機能が警告を表示します。以下の「初回起動(未署名バイナリの扱い)」の手順に沿って起動してください。警告は未署名であることに対するもので、手順どおり操作すれば起動できます。

インストール

GalleonQL は公開リポジトリ trimixjp/GalleonQL のリリースページから配布しています。

  1. リリースページ(Releases)を開きます。
  2. 最新版のリリースから、お使いの OS に対応する配布物(アセット)をダウンロードします。
    • macOS: .dmg または .app を含むアーカイブ
    • Windows: インストーラ(.msi / .exe)または実行ファイル
    • Linux: .AppImage または .deb
  3. ダウンロードしたファイルを、次の「初回起動」の手順に従って開きます。

各版の変更点は、リリースページのリリースノートを参照してください。

初回起動(未署名バイナリの扱い)

未署名のため、初回だけ OS ごとに次の操作が必要です。一度許可すれば、2 回目以降は通常どおりダブルクリックで起動できます。

macOS

macOS では、ダウンロードしたアプリに隔離属性(quarantine)が付き、通常のダブルクリックでは「開けません」と表示されることがあります。次のいずれかで起動します。

  • 方法 A(右クリックで開く): アプリ(GalleonQL.app)を 右クリック(または Control + クリック) し、メニューから 「開く」 を選びます。確認ダイアログが出たら、もう一度 「開く」 を押します。この方法で一度開くと、以降は通常どおり起動できます。

  • 方法 B(ターミナルで隔離属性を外す): 上記でも起動できない場合は、ターミナルで対象アプリの隔離属性を外します。パスはアプリを置いた場所に合わせてください。

    xattr -dr com.apple.quarantine /Applications/GalleonQL.app
    

Windows

Windows では、未署名の実行ファイルを起動しようとすると Microsoft Defender SmartScreen が「Windows によって PC が保護されました」という青い画面を表示することがあります。

  1. 画面内の 「詳細情報」 をクリックします。
  2. 表示された 「実行」 ボタンをクリックします。

これで起動できます。ファイルの入手元に心当たりがあること(公開リポジトリのリリースからダウンロードしたものであること)を確認したうえで実行してください。

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送信 ボタン、右側ドキュメントパネルの開閉。
  • 左のレール(細い縦帯): コレクション / 履歴を切り替えるアイコン。
  • 探索パネル: プロジェクト・環境・コレクション、およびリクエスト履歴。
  • リクエスト / レスポンス: 中央でクエリを組み立て(Query / Auth / Headers タブ)、送信結果を確認します。
  • ドキュメント(SCHEMA)パネル: 取り込んだスキーマの型カタログ。ここからクエリビルダーへフィールドを追加できます。

表示テーマ(ダーク / ライト / システム)やフォントサイズ、画面レイアウトは設定(⚙)から変更できます。既定はダークテーマです。

登録した環境と最後に選択していた環境、および過去に取り込んだスキーマは自動的に保存され、次回起動時に復元されます。URL やヘッダーを毎回入力し直す必要はありません。

初めて起動したときは、匿名の利用状況を共有いただき機能改善に役立てる「利用分析」へのご協力をお願いする案内が表示されることがあります。どちらを選んでも後から設定でいつでも変更できます。詳しくは 利用分析 を参照してください。

次のステップ

  1. まず接続先を用意します。環境の登録・切替 を参照して、エンドポイント URL・認証・ヘッダーを持つ 環境(接続プロファイル) を登録・選択してください。
  2. 選択中の環境に対して、GraphQL のスキーマを取り込みます。スキーマの取り込み を参照してください。
  3. 取り込んだスキーマの見方は スキーマドキュメントの参照 を参照してください。
  4. スキーマからクエリを組み立てる方法は クエリビルダー、組み立てたクエリの送信とレスポンスの見方は クエリの送信とレスポンス を参照してください。

用語で迷ったら 主要な用語 に戻れます。マニュアル全体の目次は 索引 から辿れます。