Az Azure API Management verziói

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

A korrektúrák 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 zavarná az API-fogyasztókat. Ha elkészült, aktuálissá teheti a változatot. Ugyanakkor opcionálisan közzétehet egy bejegyzést a változásnaplóban, hogy az API-fogyasztók naprakészek maradjanak a változásokkal kapcsolatban. A változásnapló közzé lesz téve a fejlesztői portálon.

Feljegyzés

A fejlesztői portál nem érhető el a használatszinten.

A változatokkal az alábbiakat végezheti el:

• Széf módosíthatja az API-definíciókat és -szabályzatokat anélkül, hogy megzavarná az éles 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.

Ismerkedjen meg a változatokkal az útmutatónk 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.

Feljegyzé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 lesz használva minden 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.

A változatot az Azure Portalon állíthatja be aktuálisként. 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.

Figyelemfelhívás

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

• Név
• Típus
• Leírás
• Előfizetés szükséges
• API-verzió
• API-verzió leírása
• Elérési út
• Protokollok

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

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. A változatokat offline állapotúként jelölheti meg az Azure Portalon.

Feljegyzé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 változatok különböző funkciók. Minden verzió több változatot is tartalmazhat, csakúgy, mint egy nem verziószámozott 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 azt tapasztalja, hogy a változatban kompatibilitástörő változások történtek, 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 kattintson a Korrektúra lap változat helyi menüjének "Verzió létrehozása változatból" elemére.