Postman でカスタム コネクタを記述するDescribe a custom connector with Postman

Postman は、速く簡単に API を開発するためのツールです。Postman is a tool for making your API development faster and easier. このチュートリアルでは、Postman Collection の作成方法を見ていただきます。Postman Collection を使うと、Microsoft Flow のカスタム コネクタを簡単に作成できます。This tutorial demonstrates how to create a Postman collection, which you can then use to easily create custom connectors in Microsoft Flow.

前提条件Prerequisites

Postman Collection を作成するCreate a Postman Collection

Azure Cognitive Services の Text Analytics API 用の Postman Collection を作成します。Let's build a Postman Collection for the Azure Cognitive Services Text Analytics API. この API は、渡されたテキストの言語、センチメント、キー フレーズを識別します。This API identifies the language, sentiment, and key phrases in text that you pass to it.

  1. Postman Collection を作成するときは、最初に要求を作成します。The first step in creating a Postman Collection is to create a request. 要求を作成するときは、HTTP 動詞、要求 URL、クエリ パラメーターまたはパス パラメーター、ヘッダー、および本文を設定できます。When creating the request, you can set the HTTP verb, the request URL, query or path parameters, headers, and the body. 詳細については、Postman のドキュメントの「Sending Requests」(要求の送信) をご覧ください。For more information, see Sending Requests in the Postman documentation. Detect Language API エンドポイントに対して、次のように値を設定します。For the Detect Language API endpoint, set the values as follows:

    Postman 要求

    使用するパラメーターと値の詳細:Details of parameters and values used:

    パラメーターParameter Value
    VerbVerb POSTPOST
    要求 URLRequest URL https://westus.api.cognitive.microsoft.com/text/analytics/v2.0/languageshttps://westus.api.cognitive.microsoft.com/text/analytics/v2.0/languages
    パラメーターParams numberOfLanguagesToDetectnumberOfLanguagesToDetect
    認証Authorization "No Auth"“No Auth”
    ヘッダーHeaders Ocp-Apim-Subscription-Key = Ocp-Apim-Subscription-Key =
    Content-Type = application/jsonContent-Type = application/json
    本文Body {
       "documents": [
         {
            "id": "1",
            "text": "Hello World"
         }
      ]
    }
  2. [Send (送信)] をクリックして要求を行い、応答を受け取ります。Click Send to make the request and get the response back.
  3. [Save (保存)] をクリックして、Postman コレクションに要求を保存します。Click Save to save the request into a Postman Collection.

    Postman の応答

  4. [Save Request (要求の保存)] ダイアログ ボックスで、[Request name (要求の名前)][Request description (要求の説明)] を入力します。Provide a Request name and Request description in the Save Request dialog box. これらの値は、カスタム コネクタで使用します。You will use these values in your custom connector.

    Postman によるコレクションの保存

    要求に対する応答を保存することもできます。You can also save the response to the request. 現在、カスタム コネクタは要求ごとに 1 つの応答のみをサポートしています。Custom connectors currently only support a single response per request. 要求ごとに複数の応答を保存すると、最初の 1 つだけが使われます。If you save multiple responses per request, only the first one is used.

    Postman による応答の保存

  5. 他の要求と応答を作成して保存し、Postman Collection の作成を続けます。Continue building your Postman Collection by creating and saving other requests and responses.
  6. すべての要求と応答の Postman Collection の作成が完了したら、コレクションをエクスポートします。Once you have completed building the Postman Collection for all your requests and responses, export the collection.

    Postman のエクスポート

  7. エクスポートの形式として、[Collection v1 (コレクション v1)] を選びます。Choose Collection v1 as the export format.

    Postman のエクスポート

この Postman Collection を使って、Microsoft Flow でカスタム コネクタを作成できるようになります。You can now use this Postman collection to create a custom connector in Microsoft Flow.

重要

Postman Collection からカスタム コネクタを作成する場合は、アクションとトリガーからヘッダー Content-type を必ず削除してください。このヘッダーは Microsoft Flow によって自動的に追加されます。When creating a custom connector from a Postman collection, be sure to remove the Content-type header from actions and triggers, as this will be automatically added by Microsoft Flow. 認証ヘッダー (たとえば、 Ocp-Apim-Subscription-Key) は [セキュリティ] セクションに定義し、アクションとトリガーからは削除する必要があります。Authentication headers (for example, Ocp-Apim-Subscription-Key) should be defined in the Security section and must be removed from actions and triggers.

詳しくは、「Microsoft Flow でカスタム コネクタを登録して使用する」をご覧ください。For more information, see Register and use custom connectors in Microsoft Flow.