Implementera testanslutning

Testanslutning är en enkel startpunkt som kan definieras för en koppling för användning med Azure Logic Apps, Power Automate eller Power Apps. Genom att exponera en åtgärd för testanslutning kan anslutningsprogrammet tillhandahålla designläges- och körningsvalidering av anslutningsparametrar.

Förutsättningar

• Grundupplevelse för att skapa logikappar eller flöden och anpassade kopplingar.
• Grundläggande förståelse för OpenAPI-specifikationen (tidigare känd som Swagger).
• Ett GitHub-konto.
• Definition av OpenAPI JSON-exempel för den här självstudien.

Lägga till en ny testanslutningsåtgärd

Att lägga till en åtgärd för TestConnection är en väldigt enkel process. Du kan välja att använda en befintlig åtgärd som ett sätt att testa anslutningen, eller lägga till en specifik åtgärd vars funktion endast är att testa anslutningsparametrarna. Åtgärden måste vara ”get” och stödja ett anrop utan parametrar, eller med hårdkodade parametrar.

Att lägga till en ny åtgärd för detta ändamål kan se ut så här i OpenAPI-specifikationen:

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

Slutpunkten som ska användas som testanslutning måste identifieras genom att du lägger till ett tillägg till API:et på den översta nivån, så här:

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

Det operationId som anges i det här attributet måste finnas i samma OpenAPI-specifikation för att vara giltigt.

Återanvända en befintlig åtgärd för testanslutning

Det är ofta enklare och mer hanterbart att identifiera en befintlig åtgärd som kan verifiera anslutningens funktion utan att det innebär en stor kostnad eller fördröjning. Detta kan utföras utan att lägga till en ny åtgärd, genom att bara ange vilken åtgärd som ska användas och vilka parametrar som ska skickas (om det finns några).

I följande exempel används en befintlig ”get”-åtgärd som kallas GetTables som bör utföras om anslutningen är giltig och parametrarna är korrekta. För att säkerställa att testanslutningsåtgärden körs så snabbt som möjligt läggs även en parameter till i anropet i exemplet för att ange att endast den första raden ska returneras.

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

Implementera testanslutning

Om du behöver implementera testanslutningen och ingen annan befintlig åtgärd är lämplig för detta ändamål kan du göra det med ett enkelt serverdelsanrop. Åtgärden behöver inte ha några parametrar eller returnera något innehåll. URL-sökvägen är också oviktig och kan väljas utifrån ditt behov. Det enda måttet på framgång för ett testanslutningsanrop är ett lyckat svar (t.ex. 200) från HTTP-anropet. I testanslutningsåtgärden begär kontraktet bara att anslutningsprogrammet verifierar autentiseringskontexten och anslutningsparametrarna.

Detta kan åstadkommas genom att helt enkelt fråga efter något enkelt på serverdelen, som använder de autentiseringsparametrar och alla databaser eller omfång som kan vara underförstådda. Att fråga efter den översta raden i en enkel tabell är ett bra exempel på en testanslutningsmetod.