Tesztkapcsolat megvalósítása

  • Cikk

A tesztkapcsolat olyan egyszerű belépési pont, amely megadható egy összekötőhöz az Azure Logic Apps, a Power Automate vagy a Power Apps alkalmazással való használathoz. Ha egy műveletet tesz elérhetővé a tesztelési kapcsolatban, az összekötő elvégezheti a kapcsolati paraméterek tervezéskori és futtatáskori érvényesítését.

Előfeltételek

Új tesztkapcsolati művelet hozzáadása

A műveletek rendkívül egyszerűen adhatók hozzá a TestConnection elemhez. Választhat, hogy egy meglévő műveletet használ a kapcsolat teszteléséhez, vagy hozzáadhat egy külön, csak a kapcsolati paraméterek tesztelésére használt műveletet. A műveletnek „get” típusúnak kell lennie, és támogatnia kell a paraméter nélküli vagy a nem módosítható paraméterekkel rendelkező hívásokat.

Egy új művelet hozzáadása erre a célra a következőképpen nézhet ki a OpenAPI specifikációban:

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

Fontos

Figyelje meg, hogy a műveletet internal műveletként jelöli meg a rendszer. Ha ehhez új belépési pontot ad hozzá, erősen ajánlott elrejteni ezt a műveletet a felhasználó elől úgy, hogy a láthatóságot ilyenként jelöli meg.

A tesztkapcsolatként használt végpontot úgy kell azonosítani, hogy egy bővítményt kell hozzáadni a legfelső szinten az API-hoz a következő módon:

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

Az ebben az attribútumban megadottnak operationId ugyanezen OpenAPI specifikáción belül kell léteznie ahhoz, hogy érvényes legyen.

Meglévő művelet újrafelhasználása tesztkapcsolathoz

Gyakran egyszerűbb és kezelhetőbb egy meglévő művelet azonosítása, amely sok költség vagy késés nélkül képes ellenőrizni a kapcsolat életképességét. Ez új művelet hozzáadása nélkül végezhető el: egyszerűen jelezni kell, hogy melyik műveletet használja és (ha van ilyen) melyik paramétert adja át a rendszer.

Az alábbi példa egy meghívott GetTables meglévő "get" műveletet használ, amelynek sikeresnek kell lennie, ha a kapcsolat érvényes, és a paraméterek helyesek. Annak érdekében, hogy a tesztkapcsolati művelet a lehető leggyorsabban fusson, a példa egy paramétert is hozzáad a híváshoz, amely megadja, hogy csak az első sort kell visszaadni.

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

Tesztkapcsolat megvalósítása

Ha tesztkapcsolatot kell megvalósítania, és más meglévő művelet nem megfelelő erre a célra, ezt egy egyszerű háttérhívással teheti meg. A műveletnek nem kell paramétereket vennie, vagy semmilyen tartalmat visszaadnia. Az URL-cím elérési útja szintén nem fontos, és igény szerint kiválasztható. A tesztkapcsolati hívások sikerének egyetlen mércéje a HTTP-hívás sikeres válasza (például 200). A tesztkapcsolati műveleten belül a szerződés azt kéri, hogy az összekötő érvényesítse a hitelesítési környezetet és a kapcsolati paramétereket.

Ez úgy valósítható meg, hogy lekérdez valami egyszerűt a háttérrendszeren, amely felhasználja a hitelesítési paramétereket és az esetlegesen feltételezett adatbázist vagy hatókört. Egy egyszerű táblázat felső sorának lekérdezése a kapcsolattesztelési módszerek egy jó példája.

Visszajelzés küldése

Nagyra értékeljük az összekötőplatform problémáival kapcsolatos visszajelzéseket és az új funkciókkal kapcsolatos ötleteket. Ha visszajelzést szeretne küldeni, lépjen a Problémák küldése vagy segítség kérése az összekötőkkel kapcsolatban részre, és válassza ki a visszajelzés típusát.