Oktatóanyag: Mock API-válaszok

Cikk
04/04/2024

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

A háttérBELI API-k importálása API Management (APIM) API-ba, vagy manuálisan jön létre és felügyelhető. Az oktatóanyag lépései az alábbiakat mutatják be:

Üres HTTP API létrehozása az API Management használatával
HTTP API manuális kezelése
Szabályzat beállítása EGY API-n, hogy a rendszer egy szimulált választ adjon vissza

Ezzel a módszerrel a fejlesztők akkor is folytathatják az API Management-példány implementálását és tesztelését, ha a háttérrendszer nem érhető el valós válaszok küldéséhez.

Tipp.

Az API-csapatok használhatják ezt a funkciót a munkaterületeken. A munkaterületek elkülönített rendszergazdai hozzáférést biztosítanak az API-khoz és saját API-futtatókörnyezetükhöz.

A válaszok szimulálásának lehetősége számos esetben hasznos:

Ha előbb az API előtérrendszere készül el, és a háttérrendszer csak később lesz megvalósítva, vagy ha a háttérrendszer fejlesztése párhuzamosan zajlik.
Ha a háttérrendszer ideiglenesen üzemen kívül van vagy nem méretezhető.

Ebben az oktatóanyagban az alábbiakkal fog megismerkedni:

Tesztelési API létrehozása
Művelet hozzáadása a tesztelési API-hoz
Válaszutánzás engedélyezése
Az utánzott API tesztelése

Mocked API-válasz

Előfeltételek

Az Azure API Management terminológiájának ismerete.
Az Azure API Management-szabályzatok alapelveinek ismerete.
Tekintse át a következő rövid útmutatót: Azure API Management-példány létrehozása.

Tesztelési API létrehozása

Az ebben a szakaszban ismertetett lépések bemutatják, hogyan hozhat létre háttérrendszer nélküli HTTP API-t.

Jelentkezzen be az Azure Portalra, majd keresse meg az API Management-példányt.
Válassza az API-k>+ API>HTTP-csempe hozzáadása lehetőséget.
A HTTP API létrehozása ablakban válassza a Teljes lehetőséget.
Adja meg a Test API-t a megjelenítendő névhez.
Válassza a Korlátlan termék lehetőséget.
Győződjön meg arról, hogy a Felügyelt elem van kiválasztva az átjárókhoz.
Válassza a Létrehozás lehetőséget.

Művelet hozzáadása a tesztelési API-hoz

Az API egy vagy több műveletet tesz elérhetővé. Ebben a szakaszban egy műveletet fog hozzáadni a létrehozott HTTP API-hoz. Ha a szakasz lépéseinek elvégzése után meghívja a műveletet, hiba lép fel. Miután elvégezte a válasz-modellezés engedélyezése szakaszban leírt lépéseket, nem fog hibaüzenetet kapni.

Portál
Azure CLI

Válassza ki az előző lépésben létrehozott API-t.
Válassza a + Művelet hozzáadása lehetőséget.

Az Előtérbeli ablakban adja meg a következő értékeket.

Előtérablak

Beállítás	Érték	Leírás
Megjelenített név	Teszthívás	A fejlesztői portálon megjelenő név.
URL (HTTP-művelet)	KAP	Válassza ki az előre definiált HTTP-parancsok egyikét.
URL-cím	/test	Az API URL-címe.
Leírás		A művelet opcionális leírása, amely az API-t használó fejlesztők számára a fejlesztői portál dokumentációjának megadására szolgál.

Válassza a Válaszok lapot az URL-cím, a Megjelenítendő név és a Leírás mezők alatt. Adja meg a beállításokat ezen a lapon a válaszállapot-kódok, tartalomtípusok, példák és sémák definiálásához.
Válassza a + Válasz hozzáadása lehetőséget, és válassza a 200 OK gombot a listából.
A jobb oldali Ábrázolások fejléc alatt válassza a + Ábrázolás hozzáadása lehetőséget.
Írja be az application/json kifejezést a keresőmezőbe, és válassza ki az alkalmazás/json tartalomtípust.
A Minta szövegmezőbe írja be a következőt: { "sampleField" : "test" }.
Válassza a Mentés lehetőséget.

Bár ehhez a példához nem szükséges, konfigurálhat további beállításokat egy API-művelethez más lapon, például:

Lap	Leírás
Lekérdezés	Adjon hozzá lekérdezési paramétereket. A név és a leírás megadása mellett megadhat olyan értékeket is, amelyek egy lekérdezési paraméterhez vannak rendelve. Az értékek egyikét megjelölheti alapértelmezettként (nem kötelező).
Kérelem	A kérelem tartalomtípusainak, példáinak és sémáinak definiálása.

Az Azure CLI használatának megkezdése:

Használja a Bash-környezetet az Azure Cloud Shellben. További információ: A Bash rövid útmutatója az Azure Cloud Shellben.
Ha inkább helyi cli-referenciaparancsokat szeretne futtatni, telepítse az Azure CLI-t. Ha Windows vagy macOS rendszert használ, fontolja meg az Azure CLI Docker-tárolóban való futtatását. További információ: Az Azure CLI futtatása Docker-tárolóban.
- Ha helyi telepítést használ, jelentkezzen be az Azure CLI-be az az login parancs futtatásával. A hitelesítési folyamat befejezéséhez kövesse a terminálon megjelenő lépéseket. További bejelentkezési lehetőségekért lásd : Bejelentkezés az Azure CLI-vel.
- Amikor a rendszer kéri, először telepítse az Azure CLI-bővítményt. További információ a bővítményekről: Bővítmények használata az Azure CLI-vel.
- Futtassa az az version parancsot a telepített verzió és a függő kódtárak megkereséséhez. A legújabb verzióra az az upgrade paranccsal frissíthet.

Ha műveletet szeretne hozzáadni a teszt API-hoz, futtassa az az apim api operation create parancsot:

az apim api operation create --resource-group apim-hello-word-resource-group \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name apim-hello-world

Futtassa az az apim API műveleti lista parancsot az API összes műveletének megtekintéséhez:

az apim api operation list --resource-group apim-hello-word-resource-group \
    --api-id test-api --service-name apim-hello-world --output table

Egy művelet eltávolításához használja az az apim api operation delete parancsot. Kérje le a műveletazonosítót az előző parancsból.

az apim api operation delete --resource-group apim-hello-word-resource-group \
    --api-id test-api --operation-id 00000000000000000000000000000000 \
    --service-name apim-hello-world

Ezt a műveletet a cikk további részében is használhatja.

Válaszutánzás engedélyezése

Válassza ki a teszt API létrehozása során létrehozott API-t.
A jobb oldali ablakban győződjön meg arról, hogy a Tervezés lap ki van jelölve.
Válassza ki a hozzáadott tesztműveletet.
A bejövő feldolgozási ablakban válassza a + Szabályzat hozzáadása lehetőséget.
Válassza a Mock válaszait a katalógusból.
Az API Management válaszának szövegmezőjébe írja be a következőt: 200 OK, alkalmazás/json. Ez a beállítás azt jelzi, hogy az API az előző szakaszban definiált mintaválaszt adja vissza.
Válassza a Mentés lehetőséget.

Tipp.

Megjelenik egy sárga sáv, amelyen a szöveg utánzása van engedélyezve . Ez azt jelzi, hogy az API Management által visszaadott válaszokat a szimulálási szabályzat utánozza, és nem a háttérrendszer hozza létre.

Az utánzott API tesztelése

Válassza ki a teszt API létrehozása során létrehozott API-t.
Kattintson a Teszt fülre.
Győződjön meg arról, hogy a Teszthívás API ki van jelölve, majd a Küldés lehetőséget választva kezdeményezhet teszthívást.
A HTTP-válasz mező az oktatóanyag első szakaszában mintaként megadott JSON-t jeleníti meg.