Bruno APIテストの探検: Bruno変数の使用詳細
Brunoは、API開発とテストのプロセスをスムーズにするために設計された革新的なAPIテストツールです。使いやすいインターフェースと強力な機能を持ち、開発者がAPIを効率的に実行・管理できるようになります。Brunoの特徴的な部分は、変数の使用であり、これによりリクエストおよび環境を通じて動的データを扱うことができます。本稿では、Brunoで使用できるさまざまな種類の変数と、どのようにAPIテスト体験を向上させるかを探ります。
Brunoにおける変数とは?
Brunoの変数を使用すると、動的値を格納し、APIリクエスト全体で再利用できます。変数を使用することで、トークンやAPIエンドポイントなどの頻繁に変化するデータを中央で管理できるため、効率が向上し、APIテストの保守性が高まります。
変数の種類
Brunoでは、5つの主要なタイプの変数をサポートしています。
コレクション変数
コレクション変数は、特定のコレクションにスコープされた変数です。複数のリクエストで使用される値を格納するのに便利です。
コレクション変数の作成手順:
- コレクション設定に移動します。
- 変数タブをクリックします。
- Pre Request Varsセクションに変数名と値を入力します。
- 変更を保存します。
使用方法:
コレクション変数は、{{varName}}
構文を使用して参照できます。
フォルダ変数
フォルダ変数は、コレクション内の特定のフォルダにスコープされます。同じ値を共有する複数のリクエストに役立ちます。
フォルダ変数の作成手順:
- サイドバーのドロップダウンメニューからフォルダ設定を開きます。
- 変数タブに移動します。
- 変数名と値を追加します。
- 変更を保存します。
使用方法:
フォルダ変数も、{{varName}}
構文で参照できます。
リクエスト変数
リクエスト変数は、APIの特定のリクエストに結びついています。バージョン1.28.0以降、すべてのリクエスト変数は文字列として扱われます。
リクエスト変数の作成手順:
- リクエストを開きます。
- 変数タブに移動します。
- 変数名と値を入力します。
- 変更を保存します。
ランタイム変数
これらは、APIクライアントのランタイム中のみ存在する一時的な変数です。セッショントークンや動的に生成されたデータの管理に役立ちます。
ランタイム変数の作成手順:bru.setVar(name, value)
関数を使います。
例:
bru.setVar("token", "res.body.token");
プロセス環境変数
これらの変数は、APIテスト内で柔軟性を提供し、{{process.env.VAR_NAME}}
構文を使用して直接アクセスできます。
変数の優先順位
変数にアクセスする際、Brunoは次の階層に従います。
- ランタイム変数
- リクエスト変数
- フォルダ変数
- コレクション変数
- 環境変数
これにより、ランタイム変数が最優先されます。
まとめ: EchoAPIを選ぶ理由
代替ツールを探している方には、EchoAPI for VS Codeを強くお勧めします。これはAPI設計、デバッグ、及び自動テストなどの機能をサポートする軽量のコラボレーションツールです。ログイン不要で、ユーザーの開発ワークフローにより良い統合が可能です。
要するに、Brunoを使用するにせよ、 EchoAPI のようなオプションを探るにせよ、変数を活用することはAPIテストプロセスを大幅に向上させる要素です。