REST API-végpontok meghívása munkafolyamatokból az Azure Logic Appsben
A következőkre vonatkozik: Azure Logic Apps (Használat + Standard)
Ha EGY REST API-végpontot egy logikai alkalmazás munkafolyamatából szeretne meghívni az Azure Logic Appsben, a beépített HTTP + Swagger műveletekkel bármilyen REST API-végpontot meghívhat egy Swagger-fájlon keresztül. A HTTP + Swagger eseményindító és művelet ugyanúgy működik, mint a HTTP-eseményindító és a művelet , de jobb élményt nyújt a munkafolyamat-tervezőben a Swagger-fájl által leírt API-struktúra és kimenetek feltárásával. A lekérdezési eseményindító implementálásához kövesse az egyéni API-k létrehozása című cikkben ismertetett lekérdezési mintát, hogy meghívjon más API-kat, szolgáltatásokat és rendszereket a logikai alkalmazás munkafolyamataiból.
Korlátozások
A HTTP + Swagger beépített műveletek jelenleg csak az OpenAPI 2.0-t támogatják, az OpenAPI 3.0-t nem.
Előfeltételek
Azure-fiók és -előfizetés. Ha nem rendelkezik Azure-előfizetéssel, regisztráljon egy ingyenes Azure-fiókra.
A meghívni kívánt cél REST API-végpontot leíró Swagger-fájl URL-címe
A REST-végpontnak általában az alábbi feltételeknek kell megfelelnie az eseményindító vagy a művelet működéséhez:
A Swagger-fájlt nyilvánosan elérhető HTTPS URL-címen kell üzemeltetni.
A Swagger-fájlnak tartalmaznia kell egy operationID tulajdonságot a definíció minden egyes műveletéhez. Ha nem, az összekötő csak az utolsó műveletet jeleníti meg a Swagger-fájlban.
A Swagger-fájlnak engedélyeznie kell a forrásközi erőforrás-megosztást (CORS ).
Feljegyzés
Ha olyan Swagger-fájlra szeretne hivatkozni, amely nincs tárolva, vagy amely nem felel meg a biztonsági és a forrásközi követelményeknek, feltöltheti a Swagger-fájlt egy Azure-tárfiók blobtárolójába, és engedélyezheti a CORS-t a tárfiókon, hogy hivatkozhasson a fájlra.
A Használat vagy a Standard logikai alkalmazás munkafolyamata, ahonnan meg szeretné hívni a célvégpontot. A HTTP + Swagger eseményindítóval való kezdéshez hozzon létre egy logikaialkalmazás-erőforrást egy üres munkafolyamattal. A HTTP + Swagger művelet használatához indítsa el a munkafolyamatot a kívánt eseményindítóval. Ez a példa a HTTP + Swagger eseményindítót használja első műveletként.
HTTP+ Swagger-eseményindító hozzáadása
Ez a beépített eseményindító HTTP-kérést küld egy REST API-t leíró Swagger-fájl URL-címére. Az eseményindító ezután a fájl tartalmát tartalmazó választ ad vissza.
Az Azure Portalon nyissa meg a logikai alkalmazás erőforrását és az üres munkafolyamatot a tervezőben.
Attól függően, hogy rendelkezik-e használati vagy standard munkafolyamattal, kövesse ezeket az általános lépéseket a HTTP + Swagger nevű HTTP-eseményindító hozzáadásához.
A Swagger végpont mezőjébe írja be a kívánt Swagger-fájl URL-címét, és válassza a Művelet hozzáadása lehetőséget.
Az alábbi példa egy nem funkcionális Swagger URL-címet használ. Előfordulhat, hogy az URL-cím más formátumot használ.
Miután a tervező megjeleníti a Swagger-fájl által leírt műveleteket, válassza ki a használni kívánt műveletet.
Adja meg azoknak az eseményindító paramétereknek az értékeit, amelyek a kiválasztott művelettől függően változnak, és amelyeket fel szeretne venni a végponthívásba.
Ha az eseményindító megköveteli az égetés ütemezésének megadását, adja meg, hogy az eseményindító milyen gyakran hívja meg a végpontot.
További elérhető paraméterek hozzáadásához nyissa meg a Speciális paraméterek listát, és válassza ki a kívánt paramétereket.
A HTTP + Swagger által elérhető hitelesítési típusokkal kapcsolatos további információkért lásd: Hitelesítés hozzáadása kimenő hívásokhoz.
Folytassa a munkafolyamat összeállítását azokkal a műveletekkel, amelyeket az eseményindító aktiválásakor futtatni szeretne.
Miután végzett, mentse a munkafolyamatot. A tervező eszköztárán válassza a Mentés lehetőséget.
HTTP + Swagger művelet hozzáadása
Ez a beépített művelet HTTP-kérést küld a REST API-t leíró Swagger-fájl URL-címére. A művelet ezután a fájl tartalmát tartalmazó választ ad vissza.
Az Azure Portalon nyissa meg a logikai alkalmazás erőforrását és munkafolyamatát a tervezőben.
Attól függően, hogy rendelkezik-e használati vagy standard munkafolyamattal, kövesse az alábbi általános lépéseket a HTTP + Swagger nevű HTTP-művelet hozzáadásához.
A Swagger végpont mezőjébe írja be a kívánt Swagger-fájl URL-címét, és válassza a Művelet hozzáadása lehetőséget.
Az alábbi példa egy nem funkcionális Swagger URL-címet használ. Előfordulhat, hogy az URL-cím más formátumot használ.
Miután a tervező megjeleníti a Swagger-fájl által leírt műveleteket, válassza ki a használni kívánt műveletet.
Adja meg a kiválasztott művelettől függően változó műveleti paraméterek értékeit, amelyeket fel szeretne venni a végponthívásba.
További elérhető paraméterek hozzáadásához nyissa meg a Speciális paraméterek listát, és válassza ki a kívánt paramétereket.
A HTTP + Swagger által elérhető hitelesítési típusokkal kapcsolatos további információkért lásd: Hitelesítés hozzáadása kimenő hívásokhoz.
Folytassa a munkafolyamat összeállítását a futtatni kívánt egyéb műveletekkel.
Miután végzett, mentse a munkafolyamatot. A tervező eszköztárán válassza a Mentés lehetőséget.
A Swagger gazdagépe az Azure Storage-ban
Továbbra is hivatkozhat olyan Swagger-fájlra, amely nincs üzemeltetve, vagy amely nem felel meg a biztonsági és a forrásközi követelményeknek. Töltse fel a Swagger-fájlt egy Azure Storage-fiók blobtárolójába, és engedélyezze a CORS-t ezen a tárfiókon. A Swagger-fájlok Azure Storage-ban való létrehozásához, beállításához és tárolásához kövesse az alábbi lépéseket:
Most engedélyezze a CORS-t a blobhoz. A tárfiók menüjében válassza a CORS lehetőséget. A Blob szolgáltatás lapján adja meg ezeket az értékeket, és válassza a Mentés lehetőséget.
Tulajdonság Érték Engedélyezett források *
Engedélyezett metódusok GET
, ,HEAD
PUT
Engedélyezett fejlécek *
Közzétett fejlécek *
Maximális életkor (másodpercben) 200
Bár ez a példa az Azure Portalt használja, használhat egy eszközt, például az Azure Storage Explorert, vagy automatikusan konfigurálhatja ezt a beállítást ezzel a PowerShell-példaszkripttel.
Blobtároló létrehozása. A tároló Áttekintés paneljén válassza a Hozzáférési szint módosítása lehetőséget. A nyilvános hozzáférési szint listájában válassza a Blob (csak blobok névtelen olvasási hozzáférése) lehetőséget, majd kattintson az OK gombra.
Töltse fel a Swagger-fájlt a blobtárolóba az Azure Portalon vagy az Azure Storage Exploreren keresztül.
A blobtárolóban lévő fájlra való hivatkozáshoz szerezze be a kis- és nagybetűket megkülönböztető formátumot követő HTTPS URL-címet az Azure Storage Explorerből:
https://<storage-account-name>.blob.core.windows.net/<blob-container-name>/<complete-swagger-file-name>?<query-parameters>
Összekötők műszaki referenciája
Ez a szakasz további információt nyújt a HTTP + Swagger-eseményindítók és -műveletek kimeneteiről.
Kimenetek
A HTTP + Swagger hívás a következő információkat adja vissza:
Tulajdonság neve | Típus | Leírás |
---|---|---|
Fejlécek | Objektum | A kérelem fejlécei |
test | Objektum | A kérelem törzstartalmat tartalmazó objektum |
állapotkód | Egész | A kérés állapotkódja |
Állapotkód | Leírás |
---|---|
200 | OK |
202 | Elfogadva |
400 | Hibás kérés |
401 | Nem engedélyezett |
403 | Forbidden |
404 | Nem található |
500 | Belső kiszolgálóhiba. Ismeretlen hiba történt. |