Oktatóanyag: Mock API-válaszok

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

A háttérbeli API-k importálhatók egy Azure API Management API-ba, vagy manuálisan jönnek létre és kerülnek felügyeletre. Az oktatóanyag lépései az alábbiakat ismertetik:

• Az API Management használatával hozzon létre egy üres HTTP API-t.
• HTTP API manuális kezelése.
• Állítson be egy szabályzatot egy API-n, hogy a rendszer egy példaválaszt adjon vissza.

Ez a módszer lehetővé teszi, hogy a fejlesztők folytatják az API Management-példány implementálását és tesztelését, még akkor is, 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 modellválaszok létrehozásának lehetősége számos esetben hasznos:

• Amikor először az API-homlokzatot tervezik, és a háttérrendszer implementációja később következik be, vagy ha a háttérrendszert párhuzamosan fejlesztik.
• Ha a háttérrendszer átmenetileg nem működik, vagy nem tud méretezni.

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

Előfeltételek

• Ismerje meg az API Management terminológiát.
• Ismerje meg az API Management szabályzatainak fogalmát.
• Teljesítse a rövid útmutatót: "Hozzon létre egy Azure API Management példányt".

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.

1. Jelentkezzen be az Azure Portalra, majd keresse meg az API Management-példányt.

2. Válassza az API-k>+ API hozzáadása>HTTP csempe lehetőséget:

   

3. A HTTP API létrehozása ablakban válassza a Teljes lehetőséget.

4. A Megjelenítendő név mezőbe írja be a Test API-t.

5. A Termékek területen válassza a Korlátlan lehetőséget, ha ez az érték elérhető. Ez az érték csak bizonyos szinteken érhető el. Az oktatóanyagban üresen hagyhatja az értéket, de az API-t egy termékhez kell társítania a közzétételhez. További információ: Az első API importálása és közzététele.

6. Az átjárókban válassza a Felügyelt lehetőséget, ha ez a lehetőség elérhető. (Ez a beállítás csak bizonyos szolgáltatási szinteken érhető el.)

7. 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 ad hozzá 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 az Enable response mocking (Válasz-szimulálás engedélyezése) szakasz lépéseit , nem fog hibaüzenetet kapni.

Portál

1. Válassza ki az előző lépésben létrehozott API-t.

2. Válassza a + Művelet hozzáadása lehetőséget.

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

   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-cím (első mező)	KAP	Válassza ki az előre definiált HTTP-parancsok egyikét.
   URL-cím (második mező)	/teszt	Az API URL-útvonala.
   Leírás		A művelet opcionális leírása. Dokumentációt nyújt a fejlesztői portálon az API-t használó fejlesztőknek.

   

4. Válassza a Válaszok lapot, amely az URL-cím, a Megjelenítendő név és a Leírás mező alatt található. Ezen a lapon értékeket fog megadni a válaszállapot-kódok, tartalomtípusok, példák és sémák definiálásához.

5. Válassza a + Válasz hozzáadása lehetőséget, majd válassza a 200 OK gombot a listából.

   

6. A Reprezentációk szakaszban válassza a +Reprezentáció hozzáadása lehetőséget.

7. Írja be az application/json kifejezést a keresőmezőbe, majd válassza ki az alkalmazás/json tartalomtípust.

8. A Minta mezőbe írja be { "sampleField" : "test" }.

9. 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, az alábbi táblázatban leírtak szerint:

Fül	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.

Azure CLI

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

• Használja a Bash-környezetet az Azure Cloud Shellben. További információ: Az Azure Cloud Shell használatának első lépései.

  

• 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: Hitelesítés az Azure-ba az Azure CLI használatával.

  • 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 és kezelése 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 <resource-group> \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name <API-management-service-name> 

Futtassa a apim API műveleti lista parancsot az API összes műveletének megjelenítéséhez.

az apim api operation list --resource-group <resource-group-name> \
    --api-id test-api --service-name <API-management-service-name> --output table

Ezt a műveletet a cikk további részében is használhatja. Ha el szeretne távolítani egy műveletet, használhatja 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 <resource-group-name> \
    --api-id test-api --operation-id <ID> \
    --service-name <API-management-service-name>

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

1. Válassza ki a teszt API létrehozása során létrehozott API-t.

2. Győződjön meg arról, hogy a Tervezés lap ki van jelölve.

3. Válassza ki a hozzáadott tesztműveletet.

4. A Bejövő feldolgozás szakaszban válassza a + Szabályzat hozzáadása lehetőséget.

   

5. Válassza ki a Mock responses csempét a katalógusból:

   

6. Győződjön meg arról, hogy a 200 OK, application/json megjelenik az API Management válaszmezőjében. Ez a kijelölés azt jelzi, hogy az API-nak az előző szakaszban meghatározott válaszmintát kell visszaadnia.

   

7. Válassza a Mentés lehetőséget.

   Tipp.

   Megjelenik egy sárga sáv, amelyen a szöveg szimulálása látható. Ez az üzenet azt jelzi, hogy az API Management által visszaadott válaszokat a szimulálási szabályzat gúnyolja, és nem a háttérrendszer hozza létre.

Az utánzott API tesztelése

1. Válassza ki a teszt API létrehozása során létrehozott API-t.

2. A Teszt lapon győződjön meg arról, hogy a Teszthívás API ki van jelölve, majd válassza a Küldés lehetőséget teszthívás indításához:

   

3. A HTTP-válasz az oktatóanyag első szakaszában mintaként megadott JSON-t jeleníti meg:

   

Következő lépés

Lépjen a következő oktatóanyagra:

Közzétett API átalakítása és védelme