연결 테스트 구현

아티클
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
      }
    }
  }