GraftQL マニュアル
変更履歴

プロジェクトのエクスポート/インポート

このページでは、プロジェクトを JSON ファイルに書き出し(エクスポート)・読み込み(インポート)する操作手順を説明します。

概要

GalleonQL は、プロジェクト単位で内容を 1 つの JSON ファイルに書き出したり、そのファイルから読み込んだり できます。次のような用途に使います。

  • バックアップ: 大切なプロジェクトをファイルとして保存しておく
  • 共有: チームや他の人にプロジェクトを渡す(Git などでの共有)
  • 持ち出し: 別のマシンへプロジェクトを移す

ここでいう「プロジェクト」には、共通ヘッダー・共通変数、環境(接続プロファイル)コレクション のツリー(フォルダ・リクエスト・お気に入り)が含まれます。用語の詳細は 主要な用語 を参照してください。

前提

  • デスクトップアプリとして起動していること(OS のファイルダイアログを使います)。
  • 操作はトップバーのプロジェクト選択メニューから行います(プロジェクト編集ドロワーの中ではありません)。

何が含まれるか・含まれないか

エクスポートしたファイルには、次のものが含まれます/含まれません。

含まれる 含まれない
プロジェクト名 / 色 / 共通ヘッダー / 共通変数 認証の秘密(Bearer トークン・Basic パスワードなど)
環境の名前 / 色 / リクエスト URL / 変数 / ヘッダー / 認証の方式のみ リクエスト履歴
コレクションツリー(フォルダ・リクエスト・お気に入り) 開いているタブの下書き
リクエストの認証は 有効/無効 + 方式 のみ スキーマのキャッシュ

⚠️ 認証トークンやパスワードはファイルに書き出されません。 これは、うっかり秘密を共有して しまわないための仕様です。インポートした後は、環境の「認証」でトークンなどを入れ直してください。

操作手順

エクスポート(特定のプロジェクトを書き出す)

  1. トップバーのプロジェクト名をクリックして、プロジェクト選択メニューを開きます。
  2. 書き出したいプロジェクト行の右側にある ↗(エクスポート) を押します。
  3. OS の保存ダイアログで、保存先とファイル名を指定します(既定のファイル名は プロジェクト名.galleonql.json)。
  4. メニュー下部に成功メッセージが表示されます(認証の秘密は含まれない旨の案内が出ます)。

鉛筆(✎ 編集)ボタンは、名前・色・共通変数などを編集するためのものです。エクスポートとは別の操作です。

インポート(新規プロジェクトとして読み込む)

プロジェクトがまだ 1 件もない状態でも、同じメニューからインポートできます。

  1. トップバーのプロジェクト名をクリックして、プロジェクト選択メニューを開きます。
  2. メニュー下部の JSON からインポート を押します。
  3. OS のファイル選択ダイアログで、読み込む .json を選びます。
  4. ファイルの検証と(必要なら)形式の変換が行われ、新規プロジェクトとして追加されます。
  5. 追加したプロジェクトが選択された状態になります。案内に従い、必要なら認証の秘密を入れ直します。

ポイント

  • インポートは常に新規プロジェクトとして追加されます。 既存のプロジェクトを上書きすることはありません。 同じ名前のプロジェクトが既にある場合は、プロジェクト名 (2) のように括弧付きの番号を付けてリネームされます。

  • 枠外 になっているプロジェクトでも、↗(エクスポート)はいつでも使えます。 課金枠の上限を超えて「選択して使う」ことができなくなったプロジェクトでも、データを JSON として 救い出せます。枠外の扱いは プロジェクト枠とプラン を参照してください。

  • お気に入り(★) は、リクエストのお気に入り状態として保持され、インポート後も復元されます。

  • ファイルの形式が新しい/古いときは、次のように扱われます。

    ファイルの形式 挙動
    いま使っているアプリより新しい 読み込みを中断し、「アプリをアップデートしてください」と表示されます
    いま使っているアプリより古い 現在の形式へ自動的に変換し、欠けている項目は既定値で補います
    現在と同じ そのまま読み込みます

エラー時の対処

症状 対処
「アプリをアップデートしてください」と表示される ファイルが新しい形式です。アプリを更新してから、もう一度インポートしてください
「対応していない形式です」と表示される GalleonQL がエクスポートしたプロジェクト JSON か確認してください(他のツールのファイルは読み込めません)
「JSON として読み込めません」と表示される ファイルが壊れていないか確認してください(テキストエディタで開けるかどうかで確認できます)
ダイアログをキャンセルした 何も変更されません(エラーも表示されません)
インポート後に送信すると認証エラーになる 認証の秘密はエクスポート対象外です。環境の「認証」で Bearer / Basic の秘密を入れ直してください(正常な挙動です)

関連ドキュメント