Kurz: Publikování několika verzí rozhraní API

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

Existují situace, kdy je pro všechny uživatele rozhraní API nepraktické používat stejnou verzi. Když jsou spotřebitelé připraveni upgradovat na novější verzi, dávají přednost jednoduchému a srozumitelnému přístupu. Jak je znázorněno v tomto kurzu, Azure API Management podporuje zveřejnění více verzí rozhraní API, aby tuto potřebu splňovalo.

Kontext najdete v částech Verze a Revize.

Návod

Týmy rozhraní API můžou tuto funkci používat v pracovních prostorech. Pracovní prostory poskytují izolovaný přístup pro správu k rozhraním API a svým vlastním runtime prostředím API.

V tomto kurzu se naučíte:

• Přidání nové verze stávajícího rozhraní API
• Výběr verzovacího schématu
• Přidání verze do produktu
• Zobrazení verze na portálu pro vývojáře

Požadavky

• Seznamte se s terminologií služby Azure API Management.
• Dokončete rychlý úvod Vytvoření instance služby Azure API Management.
• Dokončete kurz Import a publikování vašeho prvního rozhraní API.

Přidání nové verze

1. Na webu Azure Portal přejděte k vaší instanci služby API Management.
2. V nabídce vlevo v části Rozhraní API vyberte rozhraní API.
3. V seznamu rozhraní API vyhledejte Swagger Petstore – OpenAPI 3.0 . Vyberte výpustku (...) vedle Swagger Petstore – OpenAPI 3.0 a pak vyberte Přidat verzi. Do výsledného okna přidáte hodnoty v další části.

Návod

Také můžete povolit verze při vytváření nového rozhraní API. Na obrazovce Přidat rozhraní API vyberte Verzi tohoto rozhraní API?.

Výběr schématu vytváření verzí

Ve službě API Management zvolíte, jak volající určují verzi rozhraní API výběrem schématu správy verzí: Cesta, hlavička nebo řetězec dotazu. V následujícím příkladu se cesta používá jako schéma správy verzí.

V okně Vytvořit nové rozhraní API jako verzi zadejte hodnoty z následující tabulky. Potom vyberte Vytvořit a vytvořte svou verzi.

Nastavení	Hodnota	Popis
Identifikátor verze	v1	Indikátor verze specifický pro schéma. Pro Cesta přípona použita pro cestu API URL.
Schéma správy verzí	Cesta	Způsob, jakým volající zadávají verzi rozhraní API. Pokud vyberete hlavičku nebo řetězec dotazu, zadejte jinou hodnotu: název hlavičky nebo parametru řetězce dotazu. Zobrazí se příklad použití.
Úplný název verze rozhraní API	swagger-petstore-openapi-3-0-v1	Jedinečný název v instanci služby API Management Vzhledem k tomu, že verze je ve skutečnosti novým rozhraním API, které je založené na revizi rozhraní API, je tato hodnota názvem nového rozhraní API.
Produkty	Neomezené (poskytnuté v některých úrovních služeb)	Volitelně jeden nebo více produktů, ke kterým je přidružená verze rozhraní API. Pokud chcete rozhraní API publikovat, musíte ho přidružit k produktu. Verzi můžete do produktu přidat také později.

Po vytvoření verze se zobrazí v části Swagger Petstore – OpenAPI 3.0 v seznamu rozhraní API. Teď uvidíte dvě rozhraní API: Původní a v1:

Poznámka:

Pokud přidáte verzi do rozhraní API bez verzí, automaticky se vytvoří i původní verze. Tato verze odpovídá na výchozí adresu URL. Původní verze zajišťuje, že volání od existujících uživatelů budou fungovat i po přidání nové verze. Pokud vytvoříte nové rozhraní API s povolenými verzemi na začátku, žádný originál se nevytvoří.

Úprava verze

Po přidání verze ji můžete upravit a nakonfigurovat jako rozhraní API, které je oddělené od původní verze. Změny v jedné verzi nemají vliv na jinou (například pokud přidáváte nebo odebíráte operace rozhraní API nebo upravujete specifikaci OpenAPI). Další informace najdete v tématu Úprava rozhraní API.

Přidání verze do produktu

Aby volající viděli novou verzi, musí být přidána do produktu. Pokud jste verzi k produktu ještě nepřidali, můžete to udělat kdykoliv.

Přidání verze do produktu:

1. Na webu Azure Portal přejděte k vaší instanci služby API Management.
2. V části Rozhraní API v levém podokně vyberte Produkty.
3. Vyberte produkt a následně v levém panelu vyberte rozhraní API.
4. Vyberte + Přidat.
5. Vyberte rozhraní API.
6. Klepněte na tlačítko Vybrat.

Použijte sady verzí

Když vytváříte více verzí, Azure Portal vytvoří sadu verzí, která představuje sadu verzí pro jedno logické rozhraní API. Pokud vyberete název rozhraní API s více verzemi, portál zobrazí jeho sadu verzí. Název a popis sady verzí můžete přizpůsobit.

Pomocí Azure CLI můžete pracovat přímo se sadami verzí:

• Použijte prostředí Bash v Azure Cloud Shellu. Další informace najdete v tématu Začínáme s Azure Cloud Shellem.

  

• Pokud dáváte přednost místnímu spouštění referenčních příkazů rozhraní příkazového řádku, nainstalujte Azure CLI. Pokud používáte Windows nebo macOS, zvažte spuštění Azure CLI v kontejneru Docker. Další informace najdete v tématu Jak spustit Azure CLI v kontejneru Dockeru.

  • Pokud používáte místní instalaci, přihlaste se k Azure CLI pomocí příkazu az login. Pokud chcete dokončit proces ověřování, postupujte podle kroků zobrazených na terminálu. Další možnosti přihlášení najdete v tématu Ověřování v Azure pomocí Azure CLI.

  • Po zobrazení výzvy nainstalujte rozšíření Azure CLI při prvním použití. Další informace o rozšířeních najdete v tématu Použití a správa rozšíření pomocí Azure CLI.

  • Spuštěním příkazu az version zjistěte verzi a závislé knihovny, které jsou nainstalované. Pokud chcete upgradovat na nejnovější verzi, spusťte az upgrade.

Pokud chcete zobrazit všechny sady verzí, spusťte příkaz az apim api versionset list :

az apim api versionset list --resource-group <resource-group-name> \
    --service-name <API-Management-service-name> --output table

Když azure Portal vytvoří sadu verzí, přiřadí vám alfanumerický název, který se zobrazí ve sloupci Název seznamu. Tento název použijte v jiných příkazech Azure CLI.

Pokud chcete zobrazit podrobnosti o sadě verzí, spusťte příkaz az apim api versionset show :

az apim api versionset show --resource-group <resource-group-name> \
    --service-name <API-Management-service-name> --version-set-id <ID from the Name column>

Další informace o sadách verzí najdete v tématu Verze ve službě Azure API Management.

Zobrazení verze na portálu pro vývojáře

Pokud používáte portál pro vývojáře, uvidíte tam verze rozhraní API.

1. V horní části okna vyberte Portál pro vývojáře .
2. Vyberte rozhraní API a pak vyberte Swagger Petstore.
3. Měl by se zobrazit rozevírací seznam se seznamem více verzí vedle názvu rozhraní API.
4. Vyberte v1.
5. Všimněte si adresy URL požadavku první operace na seznamu. Ukazuje, že cesta URL rozhraní API zahrnuje v1.

Další krok

Přejděte k dalšímu kurzu:

Přizpůsobení stylu stránek portálu pro vývojáře