カスタムコネクタ用に Postman コレクションを作成する

[アーティクル]
06/23/2023

注意

このトピックは、Azure Logic Apps、Power Automate、および Power Apps でのカスタムコネクタの作成および使用に関するチュートリアルシリーズの一部です。カスタムコネクタの概要を必ず読んで、プロセスを理解してください。

Postman は HTTP 要求を行うためのアプリで、Postman コレクション は関連する API 要求を整理してグループ化するのに役立ちます。 API に対する OpenAPI の定義がまだない場合は、コレクションを使うと、カスタムコネクタをより迅速かつ容易に作成できます。コレクションの詳細については、Postman のドキュメントのコレクションの作成にアクセスしてください。

このトピックでは、Azure Cognitive Services Text Analytics API からの要求と応答を含むコレクションを作成します。関連するトピックで、このコレクションを使用してコネクタを作成します。

前提条件

Postman アプリ
Cognitive Services Text Analytics API の API キー

API の HTTP 要求を作成する

Postman の [Builder](ビルダー) タブで HTTP メソッドを選択し、API エンドポイントの要求 URL を入力して、認可プロトコルを選択します (ある場合)。

要求の作成: "HTTP メソッド"、"要求 URL"、"承認"。

パラメーター	価値
HTTP メソッド	投稿
要求 URL	`https://westus.api.cognitive.microsoft.com/text/analytics/v2.0/sentiment`
認可	No Auth (次の手順で API キーを指定します)

要求ヘッダーのキーと値のペアを入力します。一般的な HTTP ヘッダーの場合は、ドロップダウンリストから選択できます。

Key 価値

Ocp-Apim-Subscription-Key Your-API-subscription-key は、Cognitive Services のアカウントで確認できます。

Content-Type application/json
要求本文で送信する内容を入力します。応答を取得して要求が機能していることを確認するには、送信を選択します。
```
{
    "documents": [{
        "language": "en-us",
        "id": "1", 
        "text": "I enjoyed the new movie after a long day."
    }]
}
```
応答フィールドには、結果やエラー (発生した場合) など、API からの完全な応答が含まれます。

Key	価値
Ocp-Apim-Subscription-Key	Your-API-subscription-key は、Cognitive Services のアカウントで確認できます。
Content-Type	application/json

HTTP 要求の詳細については、要求にアクセスしてください。

コレクションを保存する

保存を選択します。

要求の保存 ダイアログで、要求の名前と説明を入力します。カスタムコネクタでは、API 操作の概要と説明にこれらの値を使用します。

要求を保存するウィンドウを示すスクリーンショット。

パラメーター	価値
要求名	DetectSentiment
要求の説明	この API により 0 から 1 の数値スコアが返されます。 1 に近いスコアは肯定的なセンチメントを示し、0 に近いスコアは否定的なセンチメントを示します。

+ コレクションの作成を選択し、コレクションの名称を入力します。 API を呼び出すときに、カスタムコネクタによってこの値が使われます。チェックマーク (✓)、コレクションフォルダを作成し、SentimentDemo に保存 を選択します。

パラメーター価値

コレクション名 SentimentDemo

パラメーター	価値
コレクション名	SentimentDemo

要求の応答を保存する

要求が保存されたので、応答を保存できます。これにより、後で要求を読み込んだ際に、応答が例として表示されます。

応答ウィンドウの上の応答の保存を選択します。

カスタムコネクタでは、応答は要求ごとに 1 つのみサポートされます。 1 つの要求に対して複数の応答を保存した場合は、最初のものだけが使用されます。
アプリの上部で、応答例の名前を入力し、例の保存を選択します。

API に追加機能がある場合、追加のリクエストとレスポンスで Postman コレクションを引き続き作成します。

Postman コレクションをエクスポートする

コレクションを JSON ファイルとしてエクスポートできます。その後、カスタムコネクタウィザードを使ってそれをインポートします。コレクションをエクスポートする前に、コンテンツの種類とセキュリティヘッダーを削除します。—これらは API 要求に必要とされていましたが、カスタムコネクタでは別の方法で処理されます。

ヘッダータブで、各ヘッダーにカーソルを合わせ、ヘッダーの横にある X を選択してそれを削除します。保存を選択して、もう一度コレクションを保存します。
コレクションの横にある省略記号 (…) を選択した後、エクスポートを選択します。
Collection v1 エクスポート形式を選択し、エクスポートを選択して、JSON ファイルを保存する場所を参照します。

注意

現在、カスタムコネクタには v1 コレクションのみを使用できます。