Azure-webalkalmazás importálása API-ként

Cikk
11/08/2023

A KÖVETKEZŐRE VONATKOZIK: Minden API Management-szint

Ez a cikk bemutatja, hogyan importálhat azure-webalkalmazásokat az Azure API Managementbe, és hogyan tesztelheti az importált API-t az Azure Portal használatával.

Feljegyzés

Az API-k importálásához és kezeléséhez használhatja a Visual Studio Code API Management-bővítményét. A telepítéshez és az első lépésekhez kövesse az API Management Bővítmény oktatóanyagát .

Ebben a cikkben az alábbiakkal ismerkedhet meg:

App Service-ben üzemeltetett webalkalmazás importálása
Az API tesztelése az Azure Portalon

Webalkalmazás közzététele AZ API Management használatával

Azure-alkalmazás szolgáltatás egy HTTP-alapú szolgáltatás webalkalmazások, REST API-k és mobil háttérrendszerek üzemeltetésére. Az API-fejlesztők az előnyben részesített technológiai vermeiket és folyamataikat használhatják API-k fejlesztésére és API-háttéralkalmazások webalkalmazásként való közzétételére biztonságos, skálázható környezetben. Ezután az API Management használatával tegye közzé a webalkalmazásokat, felügyelje és védje az API-kat az életciklusuk során, és tegye közzé őket a felhasználók számára.

Az API Management az ajánlott környezet a webalkalmazás által üzemeltetett API-k közzététele érdekében, több okból is:

Az API-felhasználók számára elérhető előtér kezelésének és védelmének leválasztása a háttérbeli webalkalmazás felügyeletéről és figyeléséről
Web Appsként üzemeltetett webes API-k kezelése a többi API-kkal azonos környezetben
Szabályzatok alkalmazása az API viselkedésének módosításához, például a hívási sebesség korlátozásához
Api-felhasználók közvetlen irányítása az API Management testre szabható fejlesztői portáljára az API-k felderítéséhez és megismeréséhez, hozzáférés kéréséhez és kipróbálásához

További információ: Tudnivalók az API Managementről.

OpenAPI-specifikáció és helyettesítő karakterek használata

Az API Management támogatja az App Service-ben üzemeltetett Web Apps importálását, amely openAPI-specifikációt (Swagger-definíciót) tartalmaz. Az OpenAPI-specifikáció azonban nem szükséges.

Ha a webalkalmazás API-definíciójában OpenAPI-specifikáció van konfigurálva, az API Management olyan API-műveleteket hoz létre, amelyek közvetlenül a definícióra vannak leképezve, a szükséges elérési utakat, paramétereket és választípusokat is beleértve.

Az OpenAPI-specifikáció használata ajánlott, mivel az API-t nagy megbízhatósággal importálja az API Managementbe, így rugalmasan ellenőrizheti, kezelheti, biztonságossá teheti és frissítheti az egyes műveletek konfigurációit.
Ha nincs megadva OpenAPI-specifikáció, az API Management helyettesítő műveleteket hoz létre a gyakori HTTP-parancsokhoz (GET, PUT stb.). Fűzzön hozzá szükséges elérési utat vagy paramétereket a helyettesítő művelethez, hogy egy API-kérést továbbítson a háttérrendszeri API-nak.

Helyettesítő karakterek használatával továbbra is kihasználhatja ugyanazokat az API Management-funkciókat, de a műveletek alapértelmezés szerint nem azonos részletességi szinten lesznek meghatározva. Mindkét esetben szerkesztheti vagy hozzáadhat műveleteket az importált API-hoz.

Példa

A háttérbeli webalkalmazás két GET-műveletet támogathat:

https://myappservice.azurewebsites.net/customer/{id}
https://myappservice.azurewebsites.net/customers

A webalkalmazást az API Management szolgáltatásba importálja egy olyan útvonalon, mint a https://contosoapi.azureapi.net/store. Az alábbi táblázat az API Managementbe importált műveleteket mutatja be OpenAPI-specifikációval vagy anélkül:

Típus	Importált műveletek	Mintakérések
OpenAPI-specifikáció	`GET /customer/{id}` `GET /customers`	`GET https://contosoapi.azureapi.net/store/customer/1` `GET https://contosoapi.azureapi.net/store/customers`
Helyettesítő	`GET /*`	`GET https://contosoapi.azureapi.net/store/customer/1` `GET https://contosoapi.azureapi.net/store/customers`

A helyettesítő karakteres művelet ugyanazokat a kéréseket engedélyezi a háttérszolgáltatásnak, mint az OpenAPI-specifikációban szereplő műveletek. Az OpenAPI által megadott műveletek azonban külön kezelhetők az API Managementben.

Előfeltételek

Tekintse át a következő rövid útmutatót: Azure API Management-példány létrehozása.
Győződjön meg arról, hogy van App Service az előfizetésében. További információt az App Service dokumentációjában talál.

Egy példa webes API létrehozásának és Azure-webalkalmazásként való közzétételének lépéseit lásd:
- Oktatóanyag: Webes API létrehozása a ASP.NET Core használatával
- ASP.NET Core-alkalmazás közzététele az Azure-ban a Visual Studio Code használatával

Nyissa meg az API Management-példányát

Az Azure Portalon keresse meg és válassza ki az API Management-szolgáltatásokat.
Az API Management-szolgáltatások lapon válassza ki az API Management-példányt.

Háttérrendszeri API importálása és közzététele

Tipp.

Az alábbi lépések az Azure API Management használatával indítják el az importálást az Azure Portalon. Az API Management szolgáltatásra közvetlenül a webalkalmazásból is hivatkozhat, ha az API Management lehetőséget választja az alkalmazás API-menüjében.

Lépjen az API Management szolgáltatásra az Azure Portalon, és válassza ki az API-kat a menüből.
Válassza ki az App Service-t a listából.
Válassza a Tallózás lehetőséget az App Services listájának megtekintéséhez az előfizetésében.
Válasszon egy App Service-t. Ha egy OpenAPI-definíció a kijelölt webalkalmazáshoz van társítva, az API Management lekéri és importálja azt.

Ha nem található OpenAPI-definíció, az API Management helyettesítő műveletek generálásával teszi elérhetővé az API-t a gyakori HTTP-műveletekhez.
Adja hozzá az API URL-cím utótagját. Az utótag lesz a név, amely azonosítja az API-t ebben az API Management-példányban. Egyedinek kell lennie az APIM-példányon belül.
Az API egy termékkel való társítással tehető közzé. Ebben az esetben az „Unlimited” terméket használjuk. Ha azt szeretné, hogy az API közzé legyen téve, és elérhető legyen a fejlesztők számára, adja hozzá egy termékhez. Ezt megteheti az API létrehozása során, vagy később is.
Feljegyzés

A termékek egy vagy több API társításai. Több API-t is megadhat, és a fejlesztői portálon elérhetővé teheti azokat a fejlesztők számára. A fejlesztőknek elő kell fizetniük a termékre az API-k eléréséhez. Amikor előfizetnek, kapnak egy előfizetési kulcsot, amely a termék minden API-jához használható. Ha Ön hozta létre az APIM-példányt, akkor már eleve rendszergazdának számít, így alapértelmezés szerint minden termékre előfizetett.

Alapértelmezés szerint az API Management minden példányához az alábbi két mintatermék jár:
- Kezdő
- Korlátlan
Adjon meg más API-beállításokat. A létrehozás során beállíthatja az értékeket, vagy később konfigurálhatja őket a Gépház lapon. A beállításokat az első API-oktatóanyag importálása és közzététele ismerteti.
Válassza a Létrehozás lehetőséget.

Az új API tesztelése az Azure Portalon

A műveleteket meg lehet hívni közvetlenül az Azure Portalról, ami kényelmes módot biztosít az API műveleteinek megtekintésére és tesztelésére. Az API-t a fejlesztői portálon vagy saját REST-ügyféleszközökkel is tesztelheti.

Válassza ki az előző lépésben létrehozott API-t.
Kattintson a Teszt fülre.
Válasszon ki egy művelet.

Az oldalon megjelennek a lekérdezési paraméterek és a fejlécek mezői. Az ehhez az API-hoz társított termék előfizetői azonosítójának egyik fejléce „Ocp-Apim-Subscription-Key” értékű. Ha Ön hozta létre az API Management-példányt, akkor már eleve rendszergazdának számít, így a kulcsot automatikusan kitölti a rendszer.
Kattintson a Küldés gombra.

Ha a teszt sikeres, a háttérrendszer 200 OK-val és néhány adattal válaszol.

Helyettesítő karakteres művelet tesztelése a portálon

Helyettesítő karakterek létrehozásakor előfordulhat, hogy a műveletek nem lesznek közvetlenül a háttér API-hoz rendelve. Az API Managementben importált helyettesítő KARAKTEREK GET művelete például alapértelmezés szerint az elérési utat / használja. Előfordulhat azonban, hogy a háttér API támogatja a GET műveletet az alábbi útvonalon:

/api/TodoItems

Az elérési utat /api/TodoItems az alábbiak szerint tesztelheti.

Válassza ki a létrehozott API-t, és válassza ki a műveletet.
Kattintson a Teszt fülre.
A sablonparaméterekben frissítse a helyettesítő karakter (*) neve melletti értéket. Például adja meg api/TodoItems. Ez az érték hozzá lesz fűzve a helyettesítő karakter művelet útvonalához / .
Válassza az Küldés lehetőséget.

Egyéb API-k hozzáfűzése

Különböző szolgáltatások által közzétett API-kat készíthet, többek között az alábbiakat:

OpenAPI-specifikáció
A SOAP API
A GraphQL API
A Azure-alkalmazás Service-ben üzemeltetett webalkalmazás
Azure-függvényalkalmazás
Azure Logic Apps
Azure Service Fabric

Fűzjön hozzá egy másik API-t a meglévő API-hoz az alábbi lépésekkel.

Feljegyzés

Egy másik API importálásakor a műveletek hozzáfűződnek az aktuális API-hoz.

Nyissa meg az Azure API Management-példányát az Azure Portalon.
Válassza az API-kat az Áttekintés lapon vagy a bal oldali menüben.
Kattintson a ... elemre azon API mellett, amelyhez egy másik API-t szeretne hozzáfűzni.
Válassza az Importálás elemet a legördülő menüből.
Válasszon egy szolgáltatást, amelyből importálni fogja az API-t.