Implementere testtilkobling

Testtilkobling er et enkelt inngangspunkt som kan defineres for en kobling for bruk med Azure Logic Apps, Power Automate, Power Apps eller Copilot Studio. Ved å eksponere en operasjon for testtilkobling, kan koblingen gi designtid og kjøretidsvalidering av tilkoblingsparametere.

Forutsetning

Pass på at du går gjennom forutsetningene for å sikre at du har det du trenger for å implementere en testtilkobling. Du må gjøre følgende:

• Grunnleggende erfaring med å bygge logikkapper eller flyter og egendefinerte koblinger.
• Grunnleggende forståelse av spesifikasjonen OpenAPI (tidligere kjent som Swagger).
• En GitHub-konto .
• Eksempeldefinisjonen OpenAPI for denne opplæringen.

Legge til en ny testtilkoblingsoperasjon

Å legge til en operasjon for TestConnection er en veldig enkel prosess. Du har muligheten til å bruke en eksisterende operasjon som et middel til å teste tilkoblingen, eller legge til en bestemt operasjon som bare har som oppgave å teste tilkoblingsparametrene. Operasjonen må være en hent og støtte en samtale uten parametere, eller med hardkodede parametere.

Å legge til en ny operasjon for dette formålet kan se slik ut i spesifikasjonen OpenAPI :

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

Endepunktet som er ment å brukes som testtilkobling, må identifiseres ved å legge til en utvidelse i API-en på øverste nivå, slik:

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

Det operationId som er angitt i dette attributtet, må finnes i den samme OpenAPI spesifikasjonen for å være gyldig.

Gjenbruk en eksisterende operasjon for testtilkobling

Ofte er det enklere og mer håndterlig å identifisere en eksisterende operasjon som kan validere levedyktigheten til tilkoblingen uten å pådra seg mye kostnader eller ventetid. Dette kan oppnås uten å legge til en ny operasjon, men ved ganske enkelt å indikere hvilken operasjon som skal brukes, og hvilke parametere som skal passeres (hvis noen).

Følgende eksempel bruker en eksisterende "get"-operasjon kalt GetTables, som skal lykkes hvis tilkoblingen er gyldig og parameterne er riktige. For å sikre at testtilkoblingsoperasjonen kjøres så raskt som mulig, legger eksemplet også til en parameter i kallet for å angi at bare den første raden skal returneres.

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

Implementer med backend-kall

Hvis du trenger å implementere testtilkobling, og ingen annen eksisterende operasjon er egnet for dette formålet, kan du gjøre det med et enkelt serverdelkall. Operasjonen trenger ikke å ta noen parametere eller returnere noe innhold. URL-banen er også uviktig, og kan velges basert på dine preferanser. Det eneste målet på suksess for et testtilkoblingskall er et vellykket svar (for eksempel 200) fra HTTP-kallet. I testtilkoblingsoperasjonen ber kontrakten om at koblingen validerer godkjenningskonteksten og tilkoblingsparameterne.

Dette kan oppnås ved å spørre etter noe enkelt på backend, som vil gjøre bruk av autentiseringsparameterne og enhver database eller omfang som kan være underforstått. Spørring etter den øverste raden i en enkel tabell er et godt eksempel på én testtilkoblingsmetode.

gi tilbakemelding

Vi setter stor pris på tilbakemeldinger om problemer med koblingsplattformen vår, eller ideer til nye funksjoner. Hvis du vil gi tilbakemelding, kan du gå til Sende inn problemer eller få hjelp med koblinger og velge tilbakemeldingstype.