實作測試連接

發行項
06/23/2023

測試連接是一個簡單的進入點，可以針對連接器定義以搭配 Azure Logic Apps、Power Automate 或 Power Apps 使用。藉由公開測試連線的作業，連接器可以提供連線參數的設計階段和執行階段驗證。

先決條件

建立邏輯應用程式或流程以及自訂連接器的基本體驗。
OpenAPI 規格的基本理解 (先前稱為 Swagger)。
GitHub 帳戶。
本教學課程的 OpenAPI 定義範例。

新增新的測試連接作業

新增 TestConnection 的作業是非常簡單的程序。您可以選擇使用任何現有的作業作為測試連線的方法，或新增僅供測試連線參數的特定作業。作業必須是 "get"，並支援不含參數或具有硬式編碼參數的呼叫。

針對此目的新增作業，在 OpenAPI 規格中可能會如下所示：

    "/diagnostics/testconnection": {
      "get": {
        "tags": [ "Diagnostics" ],
        "operationId": "TestMyAPIConnection",
        "consumes": [],
        "produces": [],
        "responses": {
          "200": { "description": "OK" },
          "default": { "description": "Operation Failed." }
        },
        "x-ms-visibility": "internal"
      }
    }

重要

請注意，這種作業會標示為 internal。如果您針對此目的新增新的進入點，強烈建議您將可見度標示為這樣，對使用者隱藏此作業。

要作為測試連線的端點必須藉由在頂層新增 API 的延伸模組來識別，如下所示：

 "x-ms-capabilities": {
    "testConnection": {
      "operationId": "TestMyAPIConnection",
      "parameters": {}
    }
  }

在這個屬性中指定的 operationId 必須存在於相同的 OpenAPI 規格中，才會生效。

重複使用現有作業以測試連接

通常這樣更簡單且更容易管理識別可驗證連線可行性的現有作業，而不會產生太多成本或延遲。這樣可以在不新增新作業的情況下完成，而是直接指出要使用的作業，以及要傳遞的參數 (如果有的話)。

在下列範例中，我們會使用稱為 GetTables 的現有 "get" 作業，如果連線有效且參數正確，就會成功。為確保測試連接作業能儘快執行，範例也會將參數新增至呼叫，以指定應該只傳回第一個資料列。

 "x-ms-capabilities": {
    "testConnection": {
      "operationId": "GetTables",
      "parameters": {
        "$top": 1
      }
    }
  }