Kurz: použití revizí k bezpečnému provedení neprůlomových změn rozhraní API

Jakmile bude vaše rozhraní API připravené a začnou ho využívat vývojáři, časem bude potřeba provádět změny rozhraní API, aniž by to mělo negativní vliv na volající vašeho rozhraní API. Také je užitečné informovat vývojáře o prováděných změnách.

V Azure API Management použijte Revize k provedení neprůlomových změn rozhraní API, abyste mohli bezpečně modelovat a testovat změny. Až budete připraveni, můžete provést revizi aktuální a nahradit aktuální rozhraní API.

Základní informace najdete v tématu verze & revize a verze API s využitím Azure API Management.

V tomto kurzu se naučíte:

  • Přidání nové revize
  • Provedení nevýznamných změn revize
  • Nastavení revize jako aktuální a přidání položky protokolu změn
  • Procházení portálu pro vývojáře a zobrazení změn a protokolu změn

Revize rozhraní API v Azure Portal

Požadavky

Přidání nové revize

  1. Přihlaste se k Azure Portala přejděte k instanci API Management.

  2. Vyberte Rozhraní API.

  3. V seznamu rozhraní API vyberte ukázková konferenční konference API (nebo jiné rozhraní API, ke kterému chcete přidat revize).

  4. Vyberte kartu Revize .

  5. Vyberte + Přidat revizi.

    Přidání revize rozhraní API

    Tip

    Můžete také vybrat Přidat revizi v místní nabídce (...) rozhraní API.

  6. Zadejte popis nové revize, který vám pomůže zapamatovat si, k čemu se bude používat.

  7. Vyberte vytvořit,

  8. Teď se vytvoří vaše nová revize.

    Poznámka

    Původní rozhraní API zůstane v Revizi 1. Vaši uživatelé nadále volají tuto revizi, dokud se nerozhodnete nastavit jako aktuální jinou revizi.

Provedení nevýznamných změn revize

  1. V seznamu rozhraní API vyberte rozhraní Demo Conference API.

  2. V horní části obrazovky vyberte kartu Návrh.

  3. Všimněte si, že jako aktuálně vybraná revize v selektoru revize (přímo nad kartou Návrh) se zobrazí Revize 2.

    Tip

    Pomocí selektoru revize můžete přepínat mezi revizemi, na kterých chcete pracovat.

  4. Vyberte + Přidat operaci.

  5. Nastavte novou operaci na POST a Název, Zobrazovaný název a adresu URL operace na test.

  6. Uložte novou operaci.

    Úprava revize

  7. Nyní jste provedli změnu Revize 2. Pomocí selektoru revizí v horní části stránky přepněte zpět na revizi 1.

  8. Všimněte si, že vaše nová operace se v Revizi 1 nezobrazí.

Nastavení revize jako aktuální a přidání položky protokolu změn

  1. V nabídce v horní části stránky vyberte kartu Revize.

  2. Otevřete místní nabídku (...) pro Revizi 2.

  3. Vyberte nastavit jako aktuální.

  4. Zaškrtněte políčko publikovat do veřejného protokolu změn pro toto rozhraní API , pokud chcete publikovat poznámky k této změně. Zadejte popis změny, kterou vývojáři uvidí, například: testování revizí. Byla přidána nová operace "test".

  5. Revize 2 je teď nastavená jako aktuální.

    Nabídka revize v okně Revize

Procházení portálu pro vývojáře a zobrazení změn a protokolu změn

Pokud jste si vyzkoušeli portál pro vývojáře, můžete si prohlédnout změny v rozhraní API a protokol změn tam.

  1. V Azure Portal vyberte rozhraní API.
  2. V horní nabídce vyberte portál pro vývojáře .
  3. Na portálu pro vývojáře vyberte rozhraní API a pak vyberte ukázková konferenční rozhraní API.
  4. Všimněte si, že je teď k dispozici vaše nová operace test.
  5. V blízkosti názvu rozhraní API vyberte protokol změn .
  6. Všimněte si, že se v tomto seznamu zobrazí vaše položka protokolu změn.

Další kroky

V tomto kurzu jste se naučili:

  • Přidání nové revize
  • Provedení nevýznamných změn revize
  • Nastavení revize jako aktuální a přidání položky protokolu změn
  • Procházení portálu pro vývojáře a zobrazení změn a protokolu změn

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

Publikování několika verzí vašeho rozhraní API