Kurz: publikování několika verzí vašeho rozhraní API
Existují situace, kdy je nepraktické, aby všichni volající na rozhraní API používali přesně stejnou verzi. Když volající chtějí upgradovat na novější verzi, chtějí mít přístup, který je snadno srozumitelný. Jak je znázorněno v tomto kurzu, je možné v Azure API Management poskytnout více verzí .
V případě pozadí si přečtěte téma verze & revize.
V tomto kurzu se naučíte:
- Přidání nové verze stávajícího rozhraní API
- Výběr schématu verze
- 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 následující rychlý Start: vytvoření instance služby Azure API Management.
- Projděte si také následující kurz: Navíc kurzu: Import a publikování vašeho prvního rozhraní API.
Přidání nové verze
- V Azure Portalpřejděte k instanci API Management.
- Vyberte Rozhraní API.
- V seznamu rozhraní API vyberte rozhraní Demo Conference API.
- Vyberte kontextovou nabídku (...) vedle pole demo konferenčního rozhraní API.
- Vyberte Přidat verzi.
Tip
Verze je možné povolit i při vytváření nového rozhraní API. Na obrazovce Přidat rozhraní API vyberte možnost verze tohoto rozhraní API?.
Výběr schématu vytváření verzí
V Azure API Management zvolíte způsob, jakým volající určuje verzi rozhraní API, výběrem schématu správy verzí: cesta, záhlaví nebo řetězec dotazu. V následujícím příkladu se jako schéma správy verzí používá cesta .
Zadejte hodnoty z následující tabulky. Pak vyberte vytvořit a vytvořte svou verzi.
| Nastavení | Hodnota | Popis |
|---|---|---|
| Název | Ukázka – konferenční rozhraní API – v1 | Jedinečný název v instanci API Management. Vzhledem k tomu, že verze je ve skutečnosti nové rozhraní API založené na revizirozhraní API, toto nastavení je nový název rozhraní API. |
| Schéma správy verzí | Cesta | Způsob, jakým volající určí verzi rozhraní API. |
| Identifikátorem verze | V1 | Indikátor verze konkrétního schématu. Pro cestu je přípona cesty URL rozhraní API. Pokud je vybraná možnost záhlaví nebo řetězec dotazu , zadejte další hodnotu: název záhlaví nebo parametr řetězce dotazu. Zobrazí se příklad použití. |
| Produkty | Unlimited | Volitelně jeden nebo více produktů, ke kterým je přiřazena verze rozhraní API. Pokud chcete rozhraní API publikovat, musíte ho přidružit k produktu. Verzi produktu můžete také přidat později. |
Po vytvoření verze se teď v seznamu rozhraní API zobrazí pod ukázkovou konferenční místností API . Teď vidíte dvě rozhraní API: původní a v1.
Nyní můžete upravit a nakonfigurovat v1 jako rozhraní API, které je oddělené od původního. Změny jedné verze nemají vliv na jinou verzi.
Poznámka
Pokud přidáte verzi do rozhraní API bez verze, bude automaticky vytvořen i původní . Tato verze reaguje na výchozí adresu URL. Vytvořením původní verze se zajistí, že proces přidávání verze neruší žádné existující volající. Pokud vytvoříte nové rozhraní API s verzemi, které jsou na začátku povolené, původní verze se nevytvoří.
Přidání verze do produktu
Aby se volajícím zobrazila nová verze, musí se přidat do produktu. Pokud jste ještě nepřidali verzi k produktu, můžete ji kdykoli přidat do produktu.
Například pro přidání verze do neomezeného produktu:
- V Azure Portal přejděte k instanci API Management.
- Vyberte možnost produkty > neomezené > rozhraní API > + Přidat.
- Vyberte ukázková konferenční konference API verze v1.
- Klikněte na Vybrat.
Použití sad verzí
Když vytvoříte více verzí, vytvoří Azure Portal sadu verzí, která představuje sadu verzí pro jedno logické rozhraní API. Vyberte název rozhraní API, které obsahuje více verzí. Azure Portal zobrazí sadu verzí. Můžete přizpůsobit název a Popis virtuální sady.
Můžete přímo komunikovat se sadami verzí pomocí Azure CLI:
V nástroji použijte prostředí Bash Azure Cloud Shell.
Pokud tomu dáváte přednost, můžete nainstalovat Azure CLI a spouštět referenční příkazy CLI.
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í jsou popsané v tématu Přihlášení 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 Využití rozšíření v 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 apim-hello-word-resource-group \
--service-name apim-hello-world --output table
Když Azure Portal vytvoří pro vás sadu verzí, přiřadí alfanumerický název, který se zobrazí ve sloupci název v seznamu. Tento název použijte v dalších příkazech rozhraní příkazového řádku Azure.
Pokud chcete zobrazit podrobnosti o sadě verzí, spusťte příkaz AZ APIM API versionset show :
az apim api versionset show --resource-group apim-hello-word-resource-group \
--service-name apim-hello-world --version-set-id 00000000000000000000000
Další informace o sadách verzí najdete v tématu verze v Azure API Management.
Zobrazení verze na portálu pro vývojáře
Pokud jste si vyzkoušeli portál pro vývojáře, můžete zobrazit verze rozhraní API.
- V horní nabídce vyberte Portál pro vývojáře.
- Vyberte Rozhraní API a pak rozhraní Demo Conference API.
- Vedle názvu rozhraní API byste měli vidět rozevírací seznam s více verzemi.
- Vyberte v1.
- Všimněte si adresy URL požadavku první operace na seznamu. Ukazuje, že cesta URL rozhraní API zahrnuje v1.
Další kroky
V tomto kurzu jste se naučili:
- Přidání nové verze stávajícího rozhraní API
- Výběr schématu verze
- Přidání verze do produktu
- Zobrazení verze na portálu pro vývojáře
Přejděte k dalšímu kurzu: