Thunder Client の使い方：パス変数とシステム変数

開発者の皆さん、APIテストの苦労から解放されたいですか？それならThunder Clientについて話しましょう。これは、VS Codeに直接統合されたスリムで軽量なREST APIクライアントです。お気に入りのエディタから離れることなく、APIリクエストを簡単に実行、テスト、デバッグできます。

Thunder Client の使い方：環境と環境変数の設定方法

このガイドでは、APIの開発とテストにおける環境変数の活用方法について詳しく解説します。Thunder Clientは、Visual Studio Code（VS Code）用の軽量なREST APIクライアント拡張機能で、環境と変数の管理に優れています。本記事を通じて、Thunder Clientを使用して効果的に環境と環境変数を設定し、複数の環境での作業を簡素化する方法を学びましょう。さらに、有用な代替ツールとして、EchoAPIもご紹介します。このツールを使えば、API開発の効率と管理が大幅に向上します。では、具体的な設定手順に進みましょう。

echoapiブログDaniel Anderson

パス変数

Thunder Clientでのパス変数は、URLパスに動的に値を挿入するのに非常に便利です。複数のエンドポイントを扱う場合やさまざまなデータポイントをテストする必要がある場合に役立ちます。使い方は次の通りです：

• 構文：URLに{variable}フォーマットを使用します。例:
  1. https://www.thunderclient.com/details/customer/{customerId}
  2. https://www.thunderclient.com/details/{customerId}{name}/

{customerId}や{name}を異なる値に置き換えることで、APIの反応を簡単に確認できます。

システム変数

Thunder Clientのシステム変数は、APIテスト用にランダムまたは動的なデータを生成します。これらの変数は、リクエストのクエリパラメータやボディに使用できます。フォーマットは{{#variableName}}です。

一般的なシステム変数:

• {{#guid}}: ランダムなUUIDを生成します。
• {{#name}}: ランダムな名前を生成します。
• {{#string}}: ランダムな文字列を生成します。
• {{#number}}: 1から1,000,000の間のランダムな数値を生成します。
  • カスタム範囲の例: {{#number, 100, 999}}
• {{#email}}: ランダムなメールアドレスを生成します。
• {{#bool}}: ランダムなブール値（trueまたはfalse）を生成します。
• {{#enum, val1, val2, val3}}: 提供された列挙値の中から一つを生成します。
  • 例: {{#enum, red, green, blue}}
• {{#date}}: ミリ秒単位のUnix日付タイムスタンプを生成します。
  • カスタム日付の例: {{#date, 'YYYY-MM-DD hh:mm:ss:fff'}}
  • マニピュレーション例: {{#date, {year:-1, day:3, mon:5}}}
• {{#dateISO}}: ISO形式の日付を生成します。
  • マニピュレーション例: {{#dateISO, {year:1}}

有料ユーザー向けの高度な機能

Thunder Clientの有料版を使用している場合、Pre Request Scriptsでfaker-js、chance、falsoなどのNodeモジュールを利用してデータを生成できます。これにより、より複雑なテストシナリオを作成できます。

Fakerの例:

var { faker } = await tc.loadModule("@faker-js/faker");
tc.setVar("firstName", faker.person.firstName());

EchoAPI: おすすめの代替品

Thunder Clientよりも一歩進んだツールをお探しなら、EchoAPI for VS Codeを検討してみてください。このツールは、超軽量でログイン不要のAPI開発コンパニオンです。Scratch Pad機能をサポートしており、Postmanの優れた代替品です。APIデザイン、デバッグ、自動テスト、負荷テストなどの機能が揃っており、Postmanスクリプトとも100％互換性があります。また、IntelliJ IDEA、VS Code、およびChrome用リクエストキャプチャ拡張機能のプラグインも付属しています。

利点:

1. ログイン不要
2. Scratch Padサポート
3. 超軽量
4. Postmanスクリプト構文と100％互換

これでThunder Clientとその機能の概要は終わりです。EchoAPI for VS Codeもぜひ一度試してみてください。Happy coding!