Sdílet prostřednictvím

Implementace testu připojení

  • Článek

Test připojení je jednoduchý vstupní bod, který je možné definovat pro konektor pro použití s Azure Logic Apps, Power Automate nebo Power Apps. Když nějakou operaci zveřejníte pro test připojení, konektor může zajistit ověřování parametrů připojení při návrhu a za běhu.

Požadavky

Přidání nové operace testu připojení

Přidání operace pro TestConnection je velmi jednoduché. K testu připojení můžete použít jakoukoli existující operaci nebo můžete přidat konkrétní operaci, jejíž jedinou úlohou je otestovat parametry připojení. Taková operace musí být operace Get a musí podporovat volání bez jakýchkoli parametrů nebo s pevně zakódovanými parametry.

Ve specifikaci OpenAPI může přidání nové operace pro tento účel vypadat nějak takto:

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

Důležité

Všimněte si, že tato operace je označená jako internal. Pokud pro tento účel přidáte nový vstupní bod, důrazně doporučujeme tuto operaci skrýt před uživateli tím, že takto označíte její viditelnost.

Koncový bod, který se má použít pro test připojení, je potřeba určit přidáním rozšíření do rozhraní API na nejvyšší úrovni, například takto:

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

Hodnota operationId zadaná v tomto atributu musí existovat v rámci stejné specifikace OpenAPI, aby byla platná.

Opětovné použití existující operace k testu připojení

Často je jednodušší a pohodlnější určit existující operaci, která může ověřit použitelnost připojení bez velkých nákladů nebo vysoké latence. Toho se dá dosáhnout bez přidání nové operace, stačí jednoduše určit operaci, která se má použít, a parametry, které se mají předat (pokud nějaké).

V následujícím příkladu se používá existující operace Get GetTables, která by měla proběhnout úspěšně, pokud je připojení platné a parametry jsou správné. Aby se zajistilo co nejrychlejší provedení operace testu připojení, v příkladu se do volání přidává také parametr určující, že se má vrátit pouze úplně první řádek.

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

Implementace testu připojení

Pokud potřebujete implementovat test připojení a žádná existující operace se k tomuto účelu nehodí, můžete to provést jednoduchým voláním back-endu. Operace nemusí přebírat žádné parametry ani vracet jakýkoli obsah. Důležitá není ani cesta URL, kterou můžete vybrat podle svého uvážení. Jediným měřítkem úspěchu volání testu připojení je úspěšná odpověď (např. 200) na volání HTTP. V rámci operace testu připojení kontrakt jednoduše vyžaduje, aby konektor ověřil kontext ověřování a parametry připojení.

K tomu stačí odeslat dotaz na back-end, ve kterém se použijí parametry ověřování a všechny příslušné databáze nebo omezení rozsahu. Dobrým příkladem jednoho přístupu k testu připojení je odeslání dotazu na první řádek jednoduché tabulky.

Poskytnutí názorů

Velmi si vážíme vašich názorů na problémy s naší platformou konektorů nebo nových nápadů na funkce. Chcete-li poskytnout zpětnou vazbu, přejděte do části Odeslat problémy nebo získat pomoc s konektory a vyberte typ zpětné vazby.