Implementera testanslutning

Testanslutning är en enkel startpunkt som kan tillhandahållas ett anslutningsprogram för användning tillsammans 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

• Grundläggande erfarenhetsbyggande logikappar eller flöden samt anpassade anslutningsprogram.
• Grundläggande förståelse för OpenAPI-specifikationen (tidigare "Swagger").
• Ett GitHub-konto.
• OpenAPI-exempeldefinition för dessa självstudier.

Lägg till en ny åtgärd för testanslutning

Det är en mycket enkel process att lägga till en åtgärd för TestConnection. 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.

Om du lägger till en ny åtgärd i detta syfte kan det se ut som på detta sätt i OpenAPI-specifikationen:

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

Viktigt

Notera att denna åtgärd markerats som internal. Om du lägger till en ny startpunkt i detta syfte rekommenderas starkt att du döljer denna åtgärd från användaren genom att markera synbarheten i enlighet därmed.

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 angetts i detta attribut måste existera inom samma OpenAPI-specifikation för att vara giltig.

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

Ofta är det enklare och mer hanterbart att identifiera en befintlig åtgärd som kan validera anslutningens giltighet utan att generera omfattande kostnader eller tidsfö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).

Följande exempel använder en befintlig "Hämta"-åtgärd kallad GetTables som skulle kunna lyckas om anslutningen är giltig och parametrarna är korrekt. För att säkerställa att åtgärden för testanslutning körs så snabbt som möjligt lägger exemplet också till en parameter i anropet med syfte att specificera att bara den första raden ska returneras.

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

Implementera testanslutning

Om du behöver implementera en testanslutning och ingen annan befintlig åtgärd lämpar sig för detta syfte, kan du göra detta med ett enkelt serverdelsanrop. Denna åtgärd behöver inte ta några parametrar eller returnera innehåll. URL:ens sökväg är också oviktig och kan väljas baserat på din preferens. Det enda framgångsmåttet för ett testanslutningsanrop är ett lyckat svar (exempelvis 200) fårn HTTP-anropet. Inom åtgärden för testanslutning begär kontraktet att anslutningsprogrammet validerar autentiseringskontext och anslutningsparametrar.

Detta kan uppnås genom att fråga efter något enkelt i serverdelen, vilket kommer att använda autentiseringsparametrarna samt eventuella databaser och begränsningar som underförstås. Att fråga efter den översta raden i en enkel tabell är ett bra exempel på en testanslutningsmetod.

Ge feedback

Vi uppskattar feedback på problem med vår plattform för anslutningsprogram eller förslag på nya funktioner. Om du vill lämna feedback går du till Skicka problem eller få hjälp med anslutningsprogram och väljer typ av feedback.