Postmanでデータアプリを実行する
郵便配達員は、API ライフサイクルを簡素化し、コラボレーションを強化して、より迅速かつ優れた API 開発を実現する API プラットフォームです。
TiDB Cloud データサービスでは、データ アプリを Postman に簡単にインポートし、Postman の豊富なツールを活用して API 開発エクスペリエンスを強化できます。
このドキュメントでは、データ アプリを Postman にインポートする方法と、Postman でデータ アプリを実行する方法について説明します。
始める前に
データ アプリを Postman にインポートする前に、次のものがあることを確認してください。
郵便配達員アカウント
Postmanデスクトップアプリ (オプション)。または、アプリをダウンロードせずに Postman Web バージョンを使用することもできます。
少なくとも 1 つの明確に定義された終点持つデータアプリ次の要件を満たすエンドポイントのみを Postman にインポートできます。
- ターゲット クラスターが選択されました。
- エンドポイント パスとリクエスト メソッドが構成されます。
- SQL ステートメントが記述されます。
データ アプリの場合はAPIキー 。
ステップ1.データアプリをPostmanにインポートする
データ アプリを Postman にインポートするには、次の手順を実行します。
TiDB Cloudコンソールで、プロジェクトのデータサービスページに移動します。
左側のペインで、対象のデータ アプリの名前をクリックして詳細を表示します。
ページの右上隅にある「Postman で実行」をクリックします。インポート手順を示すダイアログが表示されます。
注記：
- データ アプリに適切に定義されたエンドポイントがない場合 (ターゲット クラスター、パス、リクエスト メソッド、および SQL ステートメントが構成されている場合)、データ アプリに対してPostman で実行は無効のままになります。
- Chat2Query データ アプリの場合、 Postman で実行することはできません。
データ アプリのインポートについては、ダイアログに表示される手順に従います。
好みに応じて、 「Postman for Web で実行」または「Postman Desktop で実行」のいずれかを選択して Postman ワークスペースを開き、ターゲットワークスペースを選択します。
- Postman にログインしていない場合は、画面の指示に従ってまず Postman にログインしてください。
- Postman Desktop で「実行」をクリックした場合は、画面の指示に従って Postman デスクトップ アプリを起動します。
Postman のターゲット ワークスペースのページで、左側のナビゲーション メニューの[インポート]をクリックします。
TiDB Cloudダイアログからデータ アプリの URL をコピーし、その URL を Postman に貼り付けてインポートします。
URL を貼り付けると、Postman はデータ アプリを新しいコレクションとして自動的にインポートします。コレクションの名前は
TiDB Data Service - <Your App Name>形式になります。コレクションでは、展開されたエンドポイントは[展開済み]フォルダーの下にグループ化され、展開されていないエンドポイントは [**下書き]**フォルダーの下にグループ化されます。
ステップ2. PostmanでデータアプリAPIキーを設定する
インポートしたデータ アプリを Postman で実行する前に、次のように Postman でデータ アプリの API キーを構成する必要があります。
- Postman の左側のナビゲーション メニューで
TiDB Data Service - <Your App Name>クリックすると、右側にタブが開きます。 TiDB Data Service - <Your App Name>タブの下にある変数タブをクリックします。- 変数テーブルの「現在の値」列に、データ アプリの公開キーと秘密キーを入力します。
TiDB Data Service - <Your App Name>タブの右上隅にある[保存]をクリックします。
ステップ3. Postmanでデータアプリを実行する
Postman でデータ アプリを実行するには、次の手順を実行します。
Postman の左側のナビゲーション ペインで、 [デプロイ済み]または[下書き]フォルダーを展開し、エンドポイント名をクリックして右側にタブを開きます。
<Your Endpoint Name>タブでは、次のようにエンドポイントを呼び出すことができます。パラメータのないエンドポイントの場合は、 [送信]をクリックして直接呼び出すことができます。
パラメータを持つエンドポイントの場合は、まずパラメータ値を入力してから、 「送信」をクリックする必要があります。
GETまたはDELETEリクエストの場合は、クエリ パラメータテーブルにパラメータ値を入力します。POSTまたはPUTリクエストの場合は、 [Body]タブをクリックし、パラメータ値を JSON オブジェクトとして入力します。TiDB TiDB Cloud Data Service のエンドポイントでバッチ操作が有効になっている場合は、パラメータ値を JSON オブジェクトの配列としてitemsフィールドに入力します。
下のペインで応答を確認します。
異なるパラメータ値でエンドポイントを再度呼び出す場合は、パラメータ値を適宜編集し、再度「送信」をクリックします。
Postman の使用方法の詳細については、 Postman ドキュメント参照してください。
データアプリの新たな変更に対応する
データ アプリが Postman にインポートされた後、 TiDB Cloudデータ サービスはデータ アプリの新しい変更を Postman に自動的に同期しません。
新しい変更を Postman に反映させたい場合は、もう一度インポートプロセスに従う実行する必要があります。コレクション名は Postman ワークスペース内で一意であるため、最新のデータ アプリを使用して以前にインポートしたものを置き換えるか、最新のデータ アプリを新しいコレクションとしてインポートすることができます。
また、データ アプリを再インポートした後は、Postman で再度新しくインポートしたアプリのAPIキーを設定します実行する必要があります。