Postmanでデータアプリを実行する

郵便配達員 、API ライフサイクルを簡素化し、コラボレーションを強化して、より迅速かつ優れた API 開発を実現する API プラットフォームです。

TiDB Cloud データサービスでは、データ アプリを Postman に簡単にインポートし、Postman の豊富なツールを活用して API 開発エクスペリエンスを強化できます。

このドキュメントでは、データ アプリを Postman にインポートする方法と、Postman でデータ アプリを実行する方法について説明します。

始める前に

データ アプリを Postman にインポートする前に、次のものがあることを確認してください。

  • 郵便配達員アカウント

  • Postmanデスクトップアプリ (オプション)。アプリをダウンロードせずにPostmanのWebバージョンを使用することもできます。

  • 少なくとも1つの明確に定義された終点持つデータアプリ 。以下の要件を満たすエンドポイントのみをPostmanにインポートできます。

    • ターゲット クラスターが選択されました。
    • エンドポイント パスとリクエスト メソッドが構成されます。
    • SQL ステートメントが記述されます。
  • データ アプリの場合はAPIキー

ステップ1. データアプリをPostmanにインポートする

データ アプリを Postman にインポートするには、次の手順を実行します。

  1. TiDB Cloudコンソールで、プロジェクトのデータサービスページに移動します。

  2. 左側のペインで、対象のデータ アプリの名前をクリックして詳細を表示します。

  3. ページの右上隅にある「Postmanで実行」をクリックします。インポート手順を示すダイアログが表示されます。

    注記:

    • データ アプリに明確に定義されたエンドポイント (ターゲット クラスタ、パス、リクエスト メソッド、および SQL ステートメントが構成されている) がない場合、データ アプリに対してPostman で実行は無効のままになります。
    • Chat2Query データ アプリの場合、 Postman で実行することはできません。
  4. データ アプリのインポートについては、ダイアログに表示される手順に従います。

    1. 好みに応じて、 「Postman for Web で実行」または「Postman Desktop で実行」のいずれかを選択して Postman ワークスペースを開き、ターゲット ワークスペースを選択します。

      • Postman にログインしていない場合は、画面の指示に従ってまず Postman にログインしてください。
      • Postman Desktop で [実行]クリックした場合は、画面の指示に従って Postman デスクトップ アプリを起動します。
    2. Postman のターゲット ワークスペースのページで、左側のナビゲーション メニューの[インポート]をクリックします。

    3. TiDB Cloudダイアログからデータ アプリの URL をコピーし、インポートのためにその URL を Postman に貼り付けます。

  5. URLを貼り付けると、Postmanはデータアプリを新しいコレクションとして自動的にインポートします。コレクションの名前はTiDB Data Service - <Your App Name>形式になります。

    コレクションでは、展開されたエンドポイントは[展開済み]フォルダーの下にグループ化され、展開されていないエンドポイントは[下書き]フォルダーの下にグループ化されます。

ステップ2. PostmanでデータアプリAPIキーを設定する

インポートしたデータ アプリを Postman で実行する前に、次のように Postman でデータ アプリの API キーを設定する必要があります。

  1. Postman の左側のナビゲーション メニューでTiDB Data Service - <Your App Name>クリックすると、右側にタブが開きます。
  2. TiDB Data Service - <Your App Name>タブの下で、変数タブをクリックします。
  3. 変数テーブルの「現在の値」列に、データ アプリの公開キーと秘密キーを入力します。
  4. TiDB Data Service - <Your App Name>タブの右上隅にある[保存]をクリックします。

ステップ3. Postmanでデータアプリを実行する

Postman でデータ アプリを実行するには、次の手順を実行します。

  1. Postman の左側のナビゲーション ペインで、 [デプロイ済み]または[ドラフト]フォルダーを展開し、エンドポイント名をクリックして右側にタブを開きます。

  2. <Your Endpoint Name>タブでは、次のようにエンドポイントを呼び出すことができます。

    • パラメータのないエンドポイントの場合は、 [送信]をクリックして直接呼び出すことができます。

    • パラメータを持つエンドポイントの場合は、まずパラメータ値を入力してから、 「送信」をクリックする必要があります。

      • GETまたはDELETEリクエストの場合は、クエリ パラメータテーブルにパラメータ値を入力します。
      • POSTまたはPUTリクエストの場合は、 「Body」タブをクリックし、パラメータ値をJSONオブジェクトとして入力します。TiDB TiDB Cloud Data Serviceのエンドポイントでバッチ操作が有効になっている場合は、パラメータ値をJSONオブジェクトの配列としてitemsフィールドに入力します。
  3. 下のペインで応答を確認します。

  4. 異なるパラメータ値でエンドポイントを再度呼び出す場合は、パラメータ値を適宜編集し、再度「送信」をクリックします。

Postman の使用方法の詳細については、 Postmanのドキュメント参照してください。

データアプリの新たな変更に対応する

データ アプリを Postman にインポートした後、 TiDB Cloudデータ サービスはデータ アプリの新しい変更を Postman に自動的に同期しません。

Postmanに新しい変更を反映させたい場合は、もう一度インポートプロセスに従う実行する必要があります。コレクション名はPostmanワークスペース内で一意であるため、最新のデータアプリを使用して以前にインポートしたコレクションを置き換えるか、最新のデータアプリを新しいコレクションとしてインポートすることができます。

また、データ アプリを再インポートした後、Postman で再度新しくインポートしたアプリのAPIキーを設定する実行する必要があります。

このページは役に立ちましたか?