從自訂連接器的 Postman 集合建立

注意

本主題屬於在 Azure Logic Apps、Power Automate 和 Power Apps 中建立及使用自訂連接器的教學課程系列。 請務必閱讀自訂連接器概觀,以了解該程序。

Postman 是用來進行 HTTP 要求的應用程式,而 Postman 集合可協助您組織和群組相關的 API 要求。 如果您的 API 還沒有 OpenAPI 定義,則集合可讓自訂連接器的開發更快速且更容易。

在本文中,您可以建立包含 Azure 認知服務文字分析 API 要求和回應的集合。 在相關的主題中,您會使用此集合來建立連接器

先決條件

為 API 建立 HTTP 要求

  1. 在 Postman 的建立器索引標籤上,選取 HTTP 方法、輸入 API 端點的要求 URL,然後選取授權通訊協定 (如有的話)。

    建立要求:「HTTP 方法」、「要求 URL」、「授權」。

    參數 數值
    HTTP 方法 POST
    要求 URL https://westus.api.cognitive.microsoft.com/text/analytics/v2.0/sentiment
    授權 無驗證 (您會在下一個步驟中指定 API 金鑰)
  2. 輸入要求標頭的機碼值組。 針對一般 HTTP 標頭,您可以從下拉式清單中選取。

    要求 (續):標頭。

    機碼 數值
    Ocp-Apim-Subscription-Key Your-API-subscription-key,您可以在「認知服務」帳戶中找到此值。
    內容-類型 application/json
  3. 輸入您想要在要求本文中傳送的內容。 若要透過取得回應來檢查要求是否正常運作,請選取傳送

    要求 (續):「本文」。

    {
        "documents": [{
            "language": "en-us",
            "id": "1", 
            "text": "I enjoyed the new movie after a long day."
        }]
    }
    

    回應欄位包含 API 的完整回應,其中包括結果或錯誤 (如果有發生的話)。

    取得要求回覆。

儲存集合

  1. 選取儲存

    選取儲存。

  2. 儲存要求對話方塊底下,輸入要求名稱和描述。 自訂連接器會使用這些值作為 API 作業摘要和描述。

    顯示 [儲存要求] 視窗的螢幕擷取畫面。

    參數 數值
    要求名稱 DetectSentiment
    要求描述 此 API 會傳回 0 到 1 之間的數值分數。 分數接近 1 時,表示正面情感;分數接近 0 時,則表示負面情感。
  3. 選取 + 建立集合,然後輸入集合的名稱。 當您呼叫 API 時,自訂連接器會使用此值。 選取核取記號 (),這會建立集合資料夾,然後選取儲存至 SentimentDemo

    顯示建立集合步驟的螢幕擷取畫面。

    參數 數值
    集合物件名稱 SentimentDemo

儲存要求回覆

既然您已儲存您的要求,您便可以儲存回覆。 這樣一來,當您稍後載入要求時,該回覆就會顯示成一個範例。

  1. 在回應視窗上方,選取儲存回覆

    顯示 [儲存回覆] 按鈕的螢幕擷取畫面。

    自訂連接器針對每個要求只支援一個回覆。 如果您替每個要求儲存多個回覆,只會使用第一個。

  2. 在應用程式頂端,輸入您的範例回應名稱,然後選取儲存範例

    顯示如何儲存範例的螢幕擷取畫面。

如果您的 API 還有其他功能,則可以繼續使用任何其他要求和回應來建置 Postman 集合。

匯出 Postman 集合

您現在可將集合匯出為 JSON 檔案 (您接著會使用自訂連接器精靈所匯入的)。 在匯出集合之前,請移除內容類型和安全性標頭—這些是用來提出 API 要求的必要資料,但它們在自訂連接器中的處理方式不同。

  1. 標頭索引標籤底下,將滑鼠暫留在每個標頭上方,然後選取標頭旁邊的 X 以移除它。 選取儲存,再次儲存集合。

    移除標頭。

  2. 選取集合旁的省略符號 (),然後選取匯出

    匯出集合。

  3. 選取集合 v1 匯出格式、選取匯出,然後瀏覽至您想要用來儲存 JSON 檔案的位置。

    選擇匯出格式:「集合 v1」。

    注意

    目前,您只能為自訂連接器使用 v1 集合。

後續步驟

您現在已準備好根據您所建立的 Postman 集合來定義自訂連接器:

提供意見反應

非常感謝您提供有關連接器平台問題,或新功能構想的意見反應。 若要提供意見反應,請移至提交問題或取得連接器說明,然後選取您的意見反應類型。