GalleonQL ユーザーマニュアル
GalleonQL(GraphQL 特化クライアント)の利用者向けマニュアルです。用語の説明と操作の使い方を扱い、 開発者向けの内容(内部仕様・実装手順)は含めません。
(本文トピックは順次執筆します。以下は目次です。)
目次
- 概要と特徴 — GalleonQL がどんな道具か、画面の 3 区画(左のパネル〈コレクション/リクエスト履歴/スキーマ〉/リクエスト/レスポンス)、 最初にやることの順番
- GalleonQL とは(概要)/インストールと起動 — GalleonQL の概要と、各 OS(macOS / Windows / Linux)でのインストール・起動方法(macOS は Mac App Store、Windows / Linux の未署名バイナリの起動手順を含む)
- 主要な用語
— 環境(=切替可能な接続プロファイル・直交型)/コレクション/クエリ/add Query・add Child/葉と枝/
環境変数
{{...}}と GraphQL 変数$id/ヘッダーのカスケード/HTTP タイムアウトのカスケード/スキーマ - スキーマの取り込み — HTTP イントロスペクションによる取り込みと、ローカルファイルからの取り込み
- スキーマドキュメントの参照 — 取り込んだスキーマの型カタログ(型・フィールドの閲覧・検索)
- クエリビルダー — add Query/add Child によるクエリの段階的な組み立てと、粒度の切替
- 自然文からクエリを組み立てる(AI アシスト) — 文から、Jev(TypeSafe の AI)がスキーマの候補を選んでクエリの形を提案する。設定(API キー・接続テスト)、提案の確かめ方、送るもの/送らないもの、費用
- 環境の登録・切替 — 環境(接続プロファイル)の登録・編集・切替、環境変数・認証・ヘッダー・HTTP タイムアウトの設定
- 並べ替えと移動
— クエリのフィールド・コレクション・お気に入り・環境・プロジェクトの並び順の変更(ドラッグ&ドロップ/
Option(Alt)+↑↓/⋯メニュー) - 名前の変更とフォルダの作成
— フォルダ・保存クエリ・環境・プロジェクトの名前の変更(ダブルクリック/
F2/⋯メニュー)と、コレクションフォルダの作成 - クエリの送信とレスポンス — HTTP メソッドの選択、最終ヘッダーのプレビュー、送信結果とエラーの分類(ネットワーク/認証/クライアント/サーバ/部分エラー)
- リクエストフック(値の抽出と検証) — 送信後にレスポンスから環境変数へ値を取り出す/ステータスやボディを宣言的に検証する(Pro)
- プロジェクトのエクスポート/インポート — プロジェクト単位での書き出しと読み込み、他社コレクション(Postman v2.1 GraphQL・Pro)の取込
- プラン(Free / Pro)とライセンス — Free / Pro の差、Pro 限定機能(フック・検証・Subscription・スキーマ差分・他社コレクション取込)、購入・解約(macOS は Mac App Store、Windows / Linux はライセンスキー)
- クラッシュ報告 — クラッシュ/エラー報告の有効化と、送信前確認の使い方
- 利用分析 — 匿名の利用状況分析の有効化・無効化(クラッシュ報告とは別の同意)
- キーボードのショートカット
— 送信・タブとペインの移動・保存・設定を開くキー、場所ごとに効くキー、
Tabと矢印で動く方法、設定の「ショートカット」タブでのキーの変え方 - 変更履歴 — 各版の変更点は GitHub のリリースノートを参照してください(本マニュアルには本文を持たず、外部リンクのみ)