Változatok az Azure API Managementben

Minden API-kezelési szintre vonatkozik

A változatok lehetővé teszik az API-k szabályozott és biztonságos módosítását. Ha módosításokat szeretne végezni, hozzon létre egy új változatot. Ezután anélkül szerkesztheti és tesztelheti az API-t, hogy megzavarná az API-fogyasztókat. Ha elkészült, a változatot aktuálissá teheti. Ugyanakkor opcionálisan közzétehet egy bejegyzést a változásnaplóba, hogy az API-felhasználók naprakészek maradjanak a végrehajtott módosításokkal. A változásnapló közzé lesz téve a fejlesztői portálon.

Megjegyzés:

A fejlesztői portál nem érhető el a fogyasztói szintben.

A módosításokkal az alábbiakat végezheti el:

• Biztonságosan módosíthatja az API-definíciókat és -szabályzatokat anélkül, hogy megzavarná a termelési API-t.
• Közzététel előtt próbálja ki a módosításokat.
• Dokumentálja a végrehajtott módosításokat, hogy a fejlesztők megértsék az újdonságokat.
• Ha problémákat tapasztal, térjen vissza.

Kezdje el a felülvizsgálatokkal az útmutató követésével.

Adott változatok elérése

Az API minden változata egy speciálisan formázott URL-cím használatával érhető el. Fűzze 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. Ezt az URL-címet használhatja például az customers API 3. változatának eléréséhez:

https://apis.contoso.com/customers;rev=3/leads?customerId=123

Alapértelmezés szerint minden változatnak ugyanazok a biztonsági beállításai vannak, mint az aktuális változatnak. Szándékosan módosíthatja egy adott változat szabályzatát, ha különböző biztonsági beállításokat szeretne alkalmazni az egyes változatokra. Előfordulhat például, hogy ip-szűrési szabályzatot szeretne hozzáadni, hogy a külső hívók ne férhessenek hozzá a még fejlesztés alatt álló változathoz.

Megjegyzés:

Az ;rev={id} API-azonosítóhoz kell hozzáfűzni, nem pedig az URI elérési úthoz.

Aktuális változat

Egyetlen változat állítható be aktuális változatként. Ez a változat használható az összes olyan API-kéréshez, amely nem ad meg explicit változatszámot az URL-címben. A változat aktuálisként való beállításával visszaállíthatja az előző változatot.

Egy módosítást aktuálisnak állíthat be az Azure portálon. Ha a PowerShellt használja, használhatja a New-AzApiManagementApiRelease parancsmagot.

Korrektúra leírása

Amikor létrehoz egy változatot, beállíthat egy leírást saját nyomkövetési célokra. A leírások nem jelennek meg az API-felhasználók számára.

Ha aktuálisként állít be egy változatot, megadhat egy nyilvános változásnapló-megjegyzést is. A változásnaplót a fejlesztői portál tartalmazza, hogy az API-felhasználók megtekinthessenek. A változásnaplót a Update-AzApiManagementApiRelease PowerShell-parancsmaggal módosíthatja.

Caution

Ha egy API nem aktuális változatát szerkeszti, a következő tulajdonságok nem módosíthatók:

• Név
• Típus
• Description
• Előfizetés szükséges
• API-verzió
• API-verzió leírása
• Útvonal
• Protocols

Ezek a tulajdonságok csak az aktuális változatban módosíthatók. Ha a módosítások bármelyik tulajdonságát módosítják egy nem aktuális változatban, megjelenik a hibaüzenet Can't change property for non-current revision .

Korrektúra offline állapotba helyezése

A korrektúra offline állapotba hozható, így a hívók akkor sem férhetnek hozzá, ha az URL-címén keresztül próbálják elérni a változatot. Egy módosítást offline állapotúként jelölhet az Azure portálon.

Megjegyzés:

Javasoljuk, hogy offline állapotba vegye a változatokat, ha nem használja őket tesztelésre.

Verziók és változatok

A verziók és a revíziók különböző funkciók. Minden verzió több változatot is tartalmazhat, csakúgy, mint egy nemverziós API-t. A változatokat verziók használata nélkül is használhatja, vagy fordítva. A verziók általában az API-verziók kompatibilitástörő módosításokkal való elválasztására szolgálnak, míg a változatok az API kisebb és nem kompatibilitástörő módosításaihoz használhatók.

Ha a változatban kompatibilitástörő változások vannak, vagy ha hivatalosan bétaverziós/tesztelési verzióvá szeretné alakítani a változatot, létrehozhat egy verziót egy változatból. Az Azure Portalon válassza a Változatok lap korrektúra helyi menüjének "Verzió létrehozása változatból" elemét.