Az Azure API Management verziói

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

A verziók lehetővé teszik a kapcsolódó API-k csoportjainak bemutatását a fejlesztők számára. A verziókkal biztonságosan kezelheti az API kompatibilitástörő változásait. Az ügyfelek dönthetnek úgy, hogy az új API-verziót használják, amikor készen állnak, míg a meglévő ügyfelek továbbra is egy régebbi verziót használnak. A verziók egy verzióazonosítón (bármely tetszőleges sztringértéken) keresztül vannak megkülönböztetve, a verziószámozási séma pedig lehetővé teszi az ügyfelek számára, hogy meghatározzák, hogy egy API melyik verzióját szeretnék használni.

A legtöbb cél esetében minden API-verzió saját független API-nak tekinthető. Két különböző API-verzió eltérő műveletkészlettel és különböző szabályzatokkal rendelkezhet.

A következő verziókkal:

• Az API több verzióját is közzéteheti egyszerre.
• Használjon elérési utat, lekérdezési sztringet vagy fejlécet a verziók megkülönböztetéséhez.
• Használjon bármilyen sztringértéket, amelyet azonosítani szeretne a verzióban, amely lehet szám, dátum vagy név.
• Az API-verziók csoportosítva jelennek meg a fejlesztői portálon.
• Hozzon létre egy meglévő (nem verziószámozott) API-t, és hozzon létre egy új verziót a meglévő ügyfelek feltörése nélkül.

Ismerkedjen meg a verziókkal az útmutatónk követésével.

Verziószámozási sémák

A különböző API-fejlesztők eltérő követelményekkel rendelkeznek a verziószámozáshoz. Az Azure API Management nem ír elő egyetlen verziószámozási módszert, hanem több lehetőséget is kínál.

Elérési útalapú verziószámozás

Az elérési út verziószámozási sémájának használata esetén a verzióazonosítót minden API-kérés URL-elérési útjának tartalmaznia kell.

Hivatkozhat például ugyanarra products az API-ra, https://apis.contoso.com/products/v1 https://apis.contoso.com/products/v2 de a verziókra v1 és v2 a verziókra is.

Az API-kérés URL-címének formátuma az elérési útalapú verziószámozás használatakor a következő: https://{yourDomain}/{apiName}/{versionIdentifier}/{operationId}.

Fejlécalapú verziószámozás

A fejléc verziószámozási sémájának használata esetén a verzióazonosítót egy HTTP-kérés fejlécében kell szerepeltetni minden API-kérés esetében. Megadhatja a HTTP-kérelem fejlécének nevét.

Létrehozhat például egy egyéni fejlécet, Api-Versionamelyet az ügyfelek megadhatjak v1 , vagy v2 a fejléc értékében.

Lekérdezési sztringalapú verziószámozás

A lekérdezési sztring verziószámozási sémájának használatakor a verzióazonosítót minden API-kéréshez tartalmaznia kell egy lekérdezési sztringparaméterben. Megadhatja a lekérdezési sztring paraméter nevét.

Az API-kérés URL-címe a lekérdezési sztringalapú verziószámozás használatakor a következő: https://{yourDomain}/{apiName}/{operationId}?{queryStringParameterName}={versionIdentifier}.

Hivatkozhat például ugyanarra products az API-ra, https://apis.contoso.com/products?api-version=v1 https://apis.contoso.com/products?api-version=v2 de a verziókra v1 és v2 a verziókra is.

Eredeti verziók

Ha nem verziószámozott API-hoz ad hozzá verziót, a rendszer automatikusan létrehoz egy verziót Original , és az alapértelmezett URL-címen válaszol, a megadott verzióazonosító nélkül. A Original verzió biztosítja, hogy a meglévő hívók ne legyenek megtörve a verzió hozzáadásának folyamatával. Ha egy új API-t hoz létre, amelynek elején engedélyezve van a verzió, a rendszer nem hoz létre verziót Original .

A verziók ábrázolásának menete

Az Azure API Management egy verziókészletnek nevezett erőforrást tart fenn, amely egyetlen logikai API verziókészletét jelöli. A verziókészlet tartalmazza a verziószámozott API megjelenítendő nevét és a megadott verziókra irányuló kérések irányításához használt verziószámozási sémát.

Az API minden verziója saját API-erőforrásként van fenntartva, amely ezután egy verziókészlethez van társítva. A verziókészletek különböző műveletekkel vagy szabályzatokkal rendelkező API-kat tartalmazhatnak. Előfordulhat, hogy jelentős módosításokat hajt végre egy készlet verziói között.

Az Azure Portal verziókészleteket hoz létre Önnek. Az Azure Portalon módosíthatja egy verzió nevét és leírását.

A végleges verzió törlésekor a rendszer automatikusan törli a verziókészletet.

A verziókészleteket közvetlenül az Azure CLI, az Azure PowerShell, a Resource Manager-sablonok vagy az Azure Resource Manager API használatával tekintheti meg és kezelheti.

Nem verziószámozott API migrálása verziószámozott API-ba

Ha az Azure Portal használatával engedélyezi a verziószámozást egy meglévő API-n, a következő módosítások történnek az API Management-erőforrásokon:

• Létrejön egy új verziókészlet.
• A meglévő verzió megmarad, és API-verzióként Originalvan konfigurálva. Az API a verziókészlethez van csatolva, de nincs szükség verzióazonosító megadására.
• Az új verzió új API-ként jön létre, és a verziókészlethez van csatolva. Ezt az új API-t a verziószámozási sémával és -azonosítóval kell elérni.

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.

Fejlesztői portál

A fejlesztői portál külön listázza az API minden verzióját.

Az API részletei az API összes verziójának listáját is megjelenítik. Egy Original verzió verzióazonosító nélkül jelenik meg.