Share via

Revize ve službě Azure API Management

  • Článek

PLATÍ PRO: Všechny úrovně služby API Management

Revize umožňují provádět změny rozhraní API řízeným a bezpečným způsobem. Pokud chcete provést změny, vytvořte novou revizi. Pak můžete rozhraní API upravovat a testovat, aniž byste rušili uživatele rozhraní API. Až budete připravení, nastavíte revizi jako aktuální. Současně můžete volitelně publikovat záznam do protokolu změn, aby uživatelé rozhraní API měli aktuální informace o tom, co se změnilo. Protokol změn se publikuje na vývojářském portálu.

Poznámka:

Portál pro vývojáře není k dispozici na úrovni Consumption.

S revizemi můžete:

  • Sejf změny definic a zásad rozhraní API bez narušení produkčního rozhraní API.
  • Vyzkoušejte změny před jejich publikováním.
  • Zdokumentujte provedené změny, aby vývojáři pochopili, co je nového.
  • Pokud zjistíte problémy, vraťte se zpět.

Začněte s revizemi podle našeho názorného postupu.

Přístup ke konkrétním revizím

Ke každé revizi rozhraní API se dostanete pomocí speciálně vytvořené adresy URL. Připojte ;rev={revisionNumber} na konec adresy URL rozhraní API, ale před řetězec dotazu získejte přístup ke konkrétní revizi tohoto rozhraní API. Tuto adresu URL můžete například použít pro přístup k revizi 3 customers rozhraní API:

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

Ve výchozím nastavení má každá revize stejná nastavení zabezpečení jako aktuální revize. Pokud chcete, aby se pro každou revizi použilo jiné zabezpečení, můžete zásady pro určitou revizi záměrně změnit. Můžete například chtít přidat zásadu filtrování IP adres, která externím volajícím zabrání v přístupu k revizi, která je stále ve vývoji.

Poznámka:

Musí ;rev={id} být připojen k ID rozhraní API, a ne k cestě URI.

Aktuální revize

Jednu revizi lze nastavit jako aktuální revizi. Tato revize bude ta, která se použije pro všechny požadavky rozhraní API, které v adrese URL nezadávají explicitní číslo revize. Předchozí revizi můžete vrátit tak, že tuto revizi nastavíte jako aktuální.

Revizi můžete nastavit jako aktuální pomocí webu Azure Portal. Pokud používáte PowerShell, můžete použít tuto rutinu New-AzApiManagementApiRelease .

Popisy revizí

Při vytváření revize můžete nastavit popis pro vlastní účely sledování. Popisy se uživatelům rozhraní API nezobrazují.

Pokud nastavíte revizi jako aktuální, můžete také volitelně zadat poznámku k veřejnému protokolu změn. Protokol změn je součástí vývojářského portálu, kde můžou uživatelé rozhraní API zobrazit. Poznámku protokolu změn můžete upravit pomocí rutiny PowerShellu Update-AzApiManagementApiRelease .

Upozornění

Pokud upravujete neaktuální revizi rozhraní API, nemůžete změnit následující vlastnosti:

  • Název
  • Typ
  • Popis
  • Vyžaduje se předplatné
  • Verze rozhraní API
  • Popis verze rozhraní API
  • Cesta
  • Protokoly

Tyto vlastnosti lze změnit pouze v aktuální revizi. Pokud vaše úpravy změní některou z výše uvedených vlastností neaktuální revize, zobrazí se chybová zpráva Can't change property for non-current revision .

Převést revizi do offline režimu

Revizi je možné převést do offline režimu, což volajícím znepřístupňuje, i když se pokusí získat přístup k revizi prostřednictvím adresy URL. Revizi můžete označit jako offline pomocí webu Azure Portal.

Poznámka:

Doporučujeme převést revize do offline režimu, když je nepoužíváte k testování.

Verze a revize

Verze a revize jsou odlišné funkce. Každá verze může mít více revizí, stejně jako rozhraní API bez verzí. Revize můžete používat bez použití verzí nebo naopak. Verze se obvykle používají k oddělení verzí rozhraní API s zásadními změnami, zatímco revize se dají použít pro menší a nefunkční změny rozhraní API.

Pokud zjistíte, že vaše revize má zásadní změny, nebo pokud chcete formálně změnit revizi na beta/testovací verzi, můžete vytvořit verzi z revize. Na webu Azure Portal klikněte na Možnost Vytvořit verzi z revize v místní nabídce revize na kartě Revize.