Oktatóanyag: Korrektúrák használata a nem törhető API-módosítások biztonságos végrehajtásához

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

Amikor a fejlesztők használják az API-t, előbb-utóbb módosítania kell az API-t anélkül, hogy megzavarná az API hívóit. Emellett az is hasznos, ha a fejlesztők értesülnek az elvégzett módosításokról.

Az Azure API Managementben korrektúrák használatával hajthat végre nem törhető API-módosításokat. A módosításokat biztonságosan modellezheti és tesztelheti. Ha elkészült, állítsa aktuálissá a változatot, és cserélje le az aktuális API-t.

További információ: Verziók és változatok.

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.

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

• Új változat hozzáadása
• Nem törhető módosítások végrehajtása a változaton
• Változat aktuálissá tétele és módosításinapló-bejegyzés hozzáadása
• A fejlesztői portál tallózása a módosítások és a módosítási napló megtekintéséhez
• API-változat elérése

Előfeltételek

• Az Azure API Management terminológiájának ismerete.
• Tekintse át a következő rövid útmutatót: Azure API Management-példány létrehozása.
• Végezze el az alábbi oktatóanyagot: Importálja és tegye közzé az első API-t.

Új változat hozzáadása

1. Jelentkezzen be az Azure Portalra, és lépjen az API Management-példányra.

2. A bal oldali menü API-k területén válassza az API-kat.

3. Válassza ki a Swagger Petstore-t az API-listából, vagy egy másik API-t, amelyhez korrektúrákat szeretne hozzáadni.

4. Válassza a Korrektúra lapfület .

5. Válassza a + Változat hozzáadása lehetőséget.

   

   Tipp.

   A Változat hozzáadása lehetőséget az API helyi menüjében (...) is kiválaszthatja.

6. Adjon meg egy leírást az új változathoz, hogy megjegyezhesse, mire használják.

7. Válassza a Létrehozás lehetőséget.

   Az új változat létrehozása megtörtént.

   Feljegyzés

   Az eredeti API az 1. változatban marad. Ez az a változat, amelyet a felhasználók továbbra is meghívnak, amíg nem dönt úgy, hogy egy másik változatot aktuálissá tesz.

Nem törhető módosítások végrehajtása a változaton

1. Válassza ki a Swagger Petstore-t az API-listából.

2. Válassza a Tervezés lehetőséget a képernyő tetején.

   A tervezés lap feletti változatválasztó a 2. változatot jeleníti meg az aktuálisan kiválasztottként.

   Tipp.

   A változatválasztóval váltson arra a változatra, amelyen dolgozni kíván.

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

4. Állítsa be az új műveletet POST értékre, a művelet megjelenítendő nevét, nevét és URL-címét pedig tesztként.

5. Mentse az új műveletet.

   

   Most módosította a 2. változatot.

6. A lap tetején található változatválasztóval váltson vissza az 1. változatra.

   Figyelje meg, hogy az új művelet nem jelenik meg az 1. változatban.

Változat aktuálissá tétele és módosításinapló-bejegyzés hozzáadása

Portál

1. A lap tetején található menüben válassza a Korrektúrák lehetőséget.

2. Nyissa meg a 2. változat helyi menüjét (...).

3. Válassza az Aktuálissá tétele lehetőséget.

4. Ha megjegyzéseket szeretne közzétenni erről a változásról, válassza a Közzététel nyilvános változás naplóba lehetőséget ehhez az API-hoz. Adja meg a módosítás leírását, amelyet a fejlesztők láthatnak, például: Változatok tesztelése. Új "teszt" művelet hozzáadva.

   Most már a 2. változat az aktuális.

   

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.

Ezzel az eljárással hozhat létre és frissíthet egy kiadást.

1. Futtassa az az api list parancsot az API-azonosítók megtekintéséhez:

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

   A következő parancsban használni kívánt API-azonosító az Name érték. Az API-változat az ApiRevision oszlopban található.

2. A kiadás létrehozásához egy kibocsátási megjegyzéssel futtassa az az apim api release create parancsot:

   az apim api release create --resource-group apim-hello-word-resource-group \
       --api-id swagger-petstore --api-revision 2 --service-name apim-hello-world \
       --notes 'Testing revisions. Added new "test" operation.'
   

   A kiadott változat lesz az aktuális változat.

3. A kiadások megtekintéséhez használja az az apim api kiadási lista parancsát:

   az apim api release list --resource-group apim-hello-word-resource-group \
       --api-id swagger-petstore --service-name apim-hello-world --output table
   

   A megadott jegyzetek megjelennek a változásnaplóban. Az előző parancs kimenetében láthatók.

4. Kiadás létrehozásakor a --notes paraméter nem kötelező. A jegyzeteket később is hozzáadhatja vagy módosíthatja az az apim api release update paranccsal:

   az apim api release update --resource-group apim-hello-word-resource-group \
       --api-id swagger-petstore --release-id 00000000000000000000000000000000 \
       --service-name apim-hello-world --notes "Revised notes."
   

   Használja az oszlopban lévő Name értéket a kiadásazonosítóhoz.

Bármely kiadást eltávolíthat az az apim api release delete parancs futtatásával:

az apim api release delete --resource-group apim-hello-word-resource-group \
    --api-id swagger-petstore --release-id 00000000000000000000000000000000 
    --service-name apim-hello-world

A fejlesztői portál tallózása a módosítások és a módosítási napló megtekintéséhez

Ha kipróbálja a fejlesztői portált, áttekintheti az API módosításait, és ott módosíthatja a naplót.

1. Az Azure Portalon keresse meg az API Management-példányt.
2. A bal oldali menü API-k területén válassza az API-kat.
3. A felső menüben válassza a Fejlesztői portál lehetőséget.
4. A fejlesztői portálon válassza az API-kat, majd a Swagger Petstore lehetőséget.
5. Figyelje meg, hogy az új test művelet már elérhető.
6. Válassza a Napló módosítása lehetőséget az API-név közelében.
7. Figyelje meg, hogy a változásnapló-bejegyzés megjelenik a listában.

API-változat elérése

Az API minden változata egy speciálisan formázott URL-cím használatával érhető el. Adja hozzá ;rev={revisionNumber} az API URL-címének végén, de a lekérdezési sztring előtt az API egy adott változatának eléréséhez. A Swagger Petstore API 2- es verziójának eléréséhez például az alábbihoz hasonló URL-címet használhat:

https://apim-hello-world.azure-api.net/store/pet/1;rev=2/

Az API változatainak URL-elérési útjai az Azure Portal Korrektúrák lapján találhatók.

Tipp.

Az API aktuális változatát a sztring nélküli ;rev API-elérési út használatával érheti el, az API-elérési úthoz hozzáfűző ;rev={revisionNumber} teljes URL-cím mellett.

Összegzés

Ez az oktatóanyag bemutatta, hogyan végezheti el az alábbi műveleteket:

• Új változat hozzáadása
• Nem törhető módosítások végrehajtása a változaton
• Változat aktuálissá tétele és módosításinapló-bejegyzés hozzáadása
• A fejlesztői portál tallózása a módosítások és a módosítási napló megtekintéséhez
• API-változat elérése

Következő lépés

Folytassa a következő oktatóanyaggal:

Az API több verziójának közzététele