Share via

Implementowanie operacji Test connection

  • Artykuł

Połączenie testowe to prosty punkt wejścia, który można zdefiniować dla łącznika na potrzeby korzystania z usług Azure Logic Apps, Power Automate lub Power Apps. Dzięki udostępnieniu operacji dla połączenia testowego łącznik może weryfikować parametry połączenia w czasie projektowania i w czasie wykonywania.

Wymagania wstępne

Dodawanie nowej operacji Test connection

Dodawanie operacji dla TestConnection jest bardzo proste. Jako środka testowania połączenia możesz użyć dowolnej istniejącej operacji. Możesz też dodać konkretną operację, której jedynym zadaniem będzie testowanie parametrów połączenia. Operacja musi być operacją „get” i musi obsługiwać wywołanie bez parametrów lub z ustalonymi parametrami.

Dodawanie nowej operacji służącej temu celowi może wyglądać następująco w specyfikacji OpenAPI:

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

Ważne

Zauważ, że ta operacja jest oznaczona jako internal. Jeśli na potrzeby tej operacji dodajesz nowy punkt wejścia, zdecydowanie zaleca się ukrycie tej operacji przed użytkownikiem przez oznaczenie jej widoczności jako ukrytej.

Punkt końcowy, który będzie używany jako połączenie testowe, musi być identyfikowany poprzez dodanie rozszerzenia do interfejsu API na najwyższym poziomie, na przykład w ten sposób:

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

Aby identyfikator operationId określony w tym atrybucie był poprawny, musi istnieć w tej samej specyfikacji OpenAPI.

Ponowne użycie istniejącej operacji na potrzeby połączenia testowego

Aby nie ponosić dodatkowych kosztów i uniknąć opóźnień, często łatwiej jest wyznaczyć do weryfikowania żywotności połączenia istniejącą operację. Można to zrobić bez dodawania nowej operacji, a jedynie przez wskazanie operacji do użycia i parametrów, które mają zostać przekazane (jeśli takie istnieją).

W poniższym przykładzie użyto istniejącej operacji „get” o nazwie GetTables, która powinna się powieść, jeśli połączenie jest prawidłowe i parametry są poprawne. Aby zagwarantować, że operacja testowania połączenia zostanie wykonana tak szybko, jak to możliwe, w przykładzie dodano również parametr do wywołania w celu określenia, że zwracany ma być tylko pierwszy wiersz.

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

Implementowanie operacji Test connection

Jeśli zachodzi potrzeba zaimplementowania połączenia testowego i żadna inna operacja nie jest odpowiednia do tego celu, to zadanie można wykonać za pomocą bardzo prostego wywołania zaplecza. Operacja nie musi przyjmować żadnych parametrów ani zwracać żadnej zawartości. Ścieżka adresu URL jest również nieistotna i można ją wybrać na podstawie własnych preferencji. Jedyną miarą sukcesu wywołania połączenia testowego jest po prostu pomyślna odpowiedź (na przykład 200) z wywołania HTTP. W ramach operacji połączenia testowego wystarczy, że łącznik zweryfikuje kontekst uwierzytelniania i parametry połączenia.

Można to zrobić, wykonując zapytanie o jakiś element zaplecza, który korzysta z parametrów uwierzytelniania oraz z dowolnej bazy danych lub z określania zakresu, nawet w niejawny sposób. Zapytanie o górny wiersz prostej tabeli jest dobrym przykładem podejścia do połączenia testowego.

Przekazywanie opinii

Jesteśmy wdzięczni za opinie na temat problemów z platformą łączników oraz pomysły na nowe funkcje. Aby przekazać opinię, przejdź na stronę Przesyłanie problemów lub uzyskiwanie pomocy dotyczącej łączników i wybierz typ opinii.