Cvičení – vytvoření back-endového rozhraní API

Dokončeno

V tomto cvičení se naučíte provádět následující akce:

  • Vytvoření instance SLUŽBY API Management (APIM)
  • Import rozhraní API
  • Konfigurace nastavení back-endu
  • Testování rozhraní API

Požadavky

  • Účet Azure s aktivním předplatným. Pokud ho ještě nemáte, můžete si zaregistrovat bezplatnou zkušební verzi na webu https://azure.com/free.

Přihlášení k Azure

  1. Přihlaste se k webu Azure Portal a otevřete Cloud Shell.

    Umístění spouštěcího tlačítka Cloud Shellu

  2. Po otevření prostředí nezapomeňte vybrat prostředí Bash .

    Výběr prostředí Bash

Vytvoření instance API Managementu

  1. Pojďme nastavit některé proměnné pro příkazy rozhraní příkazového řádku, aby se snížilo množství přetypování. Nahraďte <myLocation> oblastí, která pro vás dává smysl. Název APIM musí být globálně jedinečný a následující skript vygeneruje náhodný řetězec. Nahraďte <myEmail> e-mailovou adresou, ke které máte přístup.

    myApiName=az204-apim-$RANDOM
    myLocation=<myLocation>
    myEmail=<myEmail>
    
  2. Vytvořte skupinu prostředků. Následující příkazy vytvoří skupinu prostředků az204-apim-rg.

    az group create --name az204-apim-rg --location $myLocation
    
  3. Vytvořte instanci APIM. Příkaz az apim create slouží k vytvoření instance. Tato --sku-name Consumption možnost se používá ke zrychlení procesu pro názorný postup.

    az apim create -n $myApiName \
        --location $myLocation \
        --publisher-email $myEmail  \
        --resource-group az204-apim-rg \
        --publisher-name AZ204-APIM-Exercise \
        --sku-name Consumption 
    

    Poznámka:

    Operace by se měla dokončit přibližně za pět minut.

Import rozhraní API back-endu

Tato část ukazuje, jak importovat a publikovat back-endové rozhraní API specifikace OpenAPI.

  1. Na webu Azure Portal vyhledejte a vyberte služby API Management.

  2. Na obrazovce API Management vyberte instanci služby API Management, kterou jste vytvořili.

  3. V navigačním podokně služby API Management v části Rozhraní API vyberte rozhraní API.

    V navigačním podokně služby vyberte rozhraní API.

  4. V seznamu vyberte OpenAPI a v automaticky otevíraných oken vyberte Úplné .

    Dialogové okno OpenAPI. Pole jsou podrobně popsána v následující tabulce.

    K vyplnění formuláře použijte hodnoty z následující tabulky. Můžete ponechat všechna pole, která nejsou uvedena ve výchozí hodnotě.

    Nastavení Hodnota Popis
    Specifikace OpenAPI https://bigconference.azurewebsites.net/ Odkazuje na službu implementovanou rozhraní API, požadavky se na tuto adresu přeposílají. Většina potřebných informací ve formuláři se po zadání vyplní automaticky.
    Zobrazované jméno Rozhraní API pro velké konference Tento název se zobrazí na portálu pro vývojáře.
    Název big-conference-api Jedinečný název pro rozhraní API.
    Popis Automaticky vyplněno Volitelný popis pro rozhraní API.
  5. Vyberte Vytvořit.

Konfigurace nastavení rozhraní API

Vytvoří se rozhraní API pro velké konference. Nakonfigurujte nastavení rozhraní API.

  1. V okně napravo vyberte Nastavení .

  2. Ověřte, že https://bigconference.azurewebsites.net/ je v poli Adresa URL webové služby.

  3. Zrušte zaškrtnutí políčka Požadované předplatné.

    Zadejte adresu URL back-endu pro rozhraní API.

  4. Zvolte Uložit.

Testování rozhraní API

Teď, když se rozhraní API naimportovalo a nakonfigurovalo, je čas rozhraní API otestovat.

  1. Vyberte Test.

    Výběr testu v pravém podokně

  2. Vyberte Speakers_Get. Na stránce se zobrazují parametry dotazu a hlavičky( pokud existuje).

  3. Vyberte Odeslat.

    Back-end předá odpověď 200 OK a nějaká data.

Vyčištění prostředků Azure

Po dokončení práce s prostředky, které jste vytvořili v tomto cvičení, můžete pomocí následujícího příkazu odstranit skupinu prostředků a všechny související prostředky.

az group delete --name az204-apim-rg