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

2025-06-02

ALKALMAZHATÓ A KÖVETKEZŐKRE: Minden API Management szint

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

Megjegyzés:

Ez a funkció jelenleg nem érhető el a munkaterületeken.

Ebben a cikkben az alábbiakkal ismerkedhet meg:

Az Azure App Service-ben üzemeltetett webalkalmazás importálása API-ként
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ásokként való közzétételére biztonságos, skálázható környezetben. Ezután az API Management használatával közzétehetik a webalkalmazásokat, kezelhetik és védhetik az API-kat az életciklusuk során, és közzétehetik őket a felhasználók számára.

Az API Management használata a Web Apps által üzemeltetett API-k közzétételével az alábbi előnyöket nyújtja:

Leválaszthatja az API-felhasználók számára elérhető előtér kezelését és védelmét a háttér-webalkalmazás kezeléséről és figyeléséről.
Webalkalmazásként üzemeltetett webes API-k kezelése a többi API-kkal azonos környezetben.
Szabályzatok alkalmazásával módosíthatja az API viselkedését, például a hívási sebesség korlátozását.
A testre szabható API Management fejlesztői portálra irányíthatja az API-fogyasztókat, így felfedezhetik és megismerhetik az API-kat, hozzáférést kérhetnek, és kipróbálhatják az API-kat.

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

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

Az API Management támogatja az App Service-ben üzemeltetett webalkalmazások importálását, amelyek openAPI-definíciót (Swagger-definíciót) tartalmaznak. OpenAPI-definícióra azonban nincs szükség.

Ha a webalkalmazás OpenAPI-definícióval van konfigurálva, az API Management ezt észleli. Másik lehetőségként manuálisan is importálhatja a definíciót az API Managementbe. Az API Management ezután olyan API-műveleteket hoz létre, amelyek közvetlenül a definícióhoz kapcsolódnak, beleértve a szükséges elérési utakat, paramétereket és választípusokat.

Az OpenAPI-definí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-definí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ő karakter művelethez, úgy, 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ér-webalkalmazás két GET-műveletet támogathat:

https://<app-service>.azurewebsites.net/customer/{id}
https://<app-service>.azurewebsites.net/customers

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

típus	Importált műveletek	Mintakérések
OpenAPI-specifikáció	`GET /customer/{id}` `GET /customers`	`GET https://<api>.azureapi.net/store/customer/1` `GET https://<api>.azureapi.net/store/customers`
Helyettesítő	`GET /*`	`GET https://<api>.azureapi.net/store/customer/1` `GET https://<api>.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

Teljesítse a rövid útmutatót: "Hozzon létre egy Azure API Management példányt".
Győződjön meg arról, hogy van alkalmazásszolgáltatás az előfizetésében. További információt az App Service dokumentációjában talál.

További információ egy példa webes API létrehozásáról és Azure-webalkalmazásként való közzétételéről:
- 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.

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

Jótanács

Az alábbi lépésekben az importálást az API Management használatával kezdheti el 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 be az API Management szolgáltatáshoz az Azure Portal felületén.
A bal oldali menü API-k szakaszában válassza az API-kat, majd az + API hozzáadása lehetőséget.
Válassza ki az App Service csempét:
A Tallózás gombra kattintva megtekintheti az előfizetésében lévő appszolgáltatások listáját.
Válasszon ki egy appszolgáltatást, majd kattintson a Kiválasztás gombra. Ha egy OpenAPI-definíció van társítva a kiválasztott webalkalmazáshoz, az API Management lekéri és importálja.

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.
ADJON hozzá egy API URL-utótagot. Az utótag egy név, amely azonosítja az API-t az API Management-példányban. Egyedinek kell lennie az API Management-példányban.
Ha azt szeretné, hogy az API közzé legyen téve és elérhető legyen a fejlesztők számára, váltson a Teljes nézetre, és társítsa az API-t egy termékkel. Ez a példa a Korlátlan terméket használja. (Az API-t a Beállítások lapon hozhatja létre vagy később is hozzáadhatja egy termékhez.)
Megjegyzés:

A termékek egy vagy több, fejlesztőknek a fejlesztői portálon keresztül kínált API-k társításai. Először a fejlesztőknek elő kell fizetnie egy termékre, hogy hozzáférjenek az API-hoz. A feliratkozás után a termék bármely API-jának előfizetési kulcsát kapják meg. Az API Management-példány létrehozójaként Ön rendszergazda, és alapértelmezés szerint minden termékre előfizet.

Bizonyos szinteken minden API Management-példányhoz két alapértelmezett mintatermék tartozik:
- Előétel
- Korlátlan
Adjon meg más API-beállításokat. Ezeket az értékeket az API létrehozásakor vagy később a Beállítások lapon állíthatja be. 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

Az Azure Portalról közvetlenül meghívhat műveleteket. Ez a módszer kényelmes módot biztosít egy 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.
A Tesztelés lapon válasszon ki egy műveletet.

Az oldalon megjelennek a lekérdezési paraméterek és a fejlécek mezői. Az egyik fejléc a Ocp-Apim-Subscription-Key. Ez a fejléc az API-hoz társított termék előfizetési kulcsához tartozik. Ha létrehozta az API Management-példányt, ön már rendszergazda, ezért a kulcs automatikusan ki lesz töltve.
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ő karakter 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 elérési úton /api/todoItems.

Az /api/todoItems elérési út teszteléséhez:

Válassza ki a létrehozott API-t, majd válasszon ki egy műveletet.
A Teszt lap Sablonparaméterek területén frissítse a helyettesítő karakter (*) neve melletti értéket. Írja be például az api/todoItems nevet. 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

Az API-kat különböző szolgáltatások által közzétett API-kból állíthatja össze, többek között a következőket:

OpenAPI-specifikáció
A SOAP alkalmazásprogramozási felület
A GraphQL programozási interfész (API)
Az Azure App Service-ben üzemeltetett webalkalmazás
Azure Functions (Felhasználói funkciók az Azure-ban)
Azure Logic Apps
Azure Service Fabric

Megjegyzés:

Api importálásakor a műveletek hozzá lesznek fűzve az aktuális API-hoz.

API hozzáfűzése egy meglévő API-hoz:

Nyissa meg az Azure API Management-példányt az Azure Portalon:
Válassza az API-k lehetőséget az Áttekintés lapon, vagy válassza az API-k>API-k opciót a bal oldali menüben.
Jelölje ki a három pontot (...) azon API mellett, amelyhez hozzá szeretne fűzni egy másik API-t.
Válassza a Importálás lehetőséget a legördülő menüből:
Válasszon egy szolgáltatást, amelyből importálni fogja az API-t.

Megosztás a következőn keresztül: