实施测试连接

项目
06/23/2023

测试连接是一种简单的入口点，您可以为用于 Azure 逻辑应用、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
      }
    }
  }