Kurz: Použití rozšíření API Management pro Visual Studio Kód k importu a správě rozhraní API

V tomto kurzu se naučíte používat rozšíření API Management pro Visual Studio Code pro běžné operace v API Management. Pomocí známého prostředí Visual Studio Code můžete importovat, aktualizovat, testovat a spravovat rozhraní API.

Získáte informace o těchto tématech:

  • Import rozhraní API do API Management
  • Úprava rozhraní API
  • Použití zásad API Management
  • Testování rozhraní API

API in API Management Extension

Úvod k dalším funkcím API Management najdete v API Management kurzech s využitím Azure Portal.

Požadavky

Import rozhraní API

Následující příklad naimportuje specifikaci OpenAPI ve formátu JSON do API Management. Microsoft poskytuje back-endové rozhraní API používané v tomto příkladu a hostuje ho v Azure na adrese https://conferenceapi.azurewebsites.net?format=json.

  1. V Visual Studio Code vyberte ikonu Azure na panelu aktivit.
  2. V podokně Průzkumník rozbalte API Management instanci, kterou jste vytvořili.
  3. Klikněte pravým tlačítkem na rozhraní API a vyberte Importovat z odkazu OpenAPI.
  4. Po zobrazení výzvy zadejte následující hodnoty:
    1. Odkaz OpenAPI pro obsah ve formátu JSON. V tomto příkladu: https://conferenceapi.azurewebsites.net?format=json. Tato adresa URL je služba, která implementuje ukázkové rozhraní API. API Management přesměrovávat požadavky na tuto adresu.
    2. Název rozhraní API, například demo-conference-api, který je jedinečný v instanci API Management. Tento název může obsahovat pouze písmena, číslice a pomlčky. První a poslední znaky musí být alfanumerické. Tento název se používá v cestě k volání rozhraní API.

Po úspěšném importu rozhraní API se zobrazí v podokně Průzkumníka a v uzlu Operace se zobrazí dostupné operace rozhraní API.

Imported API in Explorer pane

Úprava rozhraní API

Rozhraní API můžete upravit v kódu Visual Studio. Upravte například Resource Manager popis rozhraní API v okně editoru a odeberte protokol HTTP použitý pro přístup k rozhraní API.

Edit JSON description

Pokud chcete upravit formát OpenAPI, klikněte pravým tlačítkem myši na název rozhraní API v podokně Průzkumník a vyberte Upravit OpenAPI. Proveďte změny a pak vyberteUložitsoubor>.

Použití zásad pro rozhraní API

API Management poskytuje zásady, které můžete nakonfigurovat pro vaše rozhraní API. Zásady jsou kolekcí příkazů. Tyto příkazy se spouštějí postupně na požadavku nebo odpovědi rozhraní API. Zásady můžou být globální, které platí pro všechna rozhraní API ve vaší instanci API Management nebo specifické pro produkt, rozhraní API nebo operaci rozhraní API.

V této části se dozvíte, jak u rozhraní API použít běžné odchozí zásady, které transformují odpověď rozhraní API. Zásady v tomto příkladu mění hlavičky odpovědi a skryjí původní adresy URL back-endu, které se zobrazují v textu odpovědi.

  1. V podokně Průzkumník vyberte v části Demo-conference-api , které jste naimportovali. Soubor zásad se otevře v okně editoru. Tento soubor konfiguruje zásady pro všechny operace v rozhraní API.

  2. Aktualizujte soubor následujícím obsahem v elementu <outbound> :

    [...]
    <outbound>
        <set-header name="Custom" exists-action="override">
            <value>"My custom value"</value>
        </set-header>
        <set-header name="X-Powered-By" exists-action="delete" />
        <redirect-content-urls />
        <base />
    </outbound>
    [...]
    
    • set-header První zásada přidá vlastní hlavičku odpovědi pro demonstrační účely.
    • Druhá set-header zásada odstraní hlavičku X-Powered-By , pokud existuje. Tato hlavička může odhalit architekturu aplikace používanou v back-endu rozhraní API a vydavatelé ji často odeberou.
    • Zásady redirect-content-urls přepisují (masky) odkazů v textu odpovědi, aby odkazy přes bránu API Management odkazy ukazovaly na ekvivalentní odkazy.
  3. Soubor uložte. Pokud se zobrazí výzva, vyberte Upload a nahrajte soubor do cloudu.

Testování rozhraní API

Získání klíče předplatného

K otestování importovaného rozhraní API a použitých zásad potřebujete klíč předplatného pro vaši instanci API Management.

  1. V podokně Průzkumník klikněte pravým tlačítkem myši na název vaší instance API Management.

  2. Vyberte Kopírovat klíč předplatného.

    Copy subscription key

Testování operace rozhraní API

  1. V podokně Průzkumník rozbalte uzel Operace pod ukázkovým rozhraním API konference , které jste naimportovali.
  2. Vyberte operaci, jako je GetSpeakers, a potom klikněte pravým tlačítkem myši na operaci a vyberte testovat operaci.
  3. V okně editoru vedle klíče Ocp-Apim-Subscription-Key nahraďte {{SubscriptionKey}} zkopírovaným klíčem předplatného.
  4. Vyberte Odeslat žádost.

Send API request from Visual Studio Code

Když požadavek proběhne úspěšně, back-end odpoví na 200 OK a některá data.

API test operation

Všimněte si následujících podrobností v odpovědi:

  • Do odpovědi se přidá vlastní hlavička.
  • Hlavička X-Powered-By se v odpovědi nezobrazí.
  • Adresy URL na back-end rozhraní API se přesměrují na bránu API Management v tomto případě https://apim-hello-world.azure-api.net/demo-conference-api.

Trasování operace rozhraní API

Podrobné informace o trasování, které vám pomůžou ladit operaci rozhraní API, vyberte odkaz, který se zobrazí vedle Ocp-APIM-Trace-Location.

Soubor JSON v daném umístění obsahuje informace o příchozím, back-endovém a odchozím trasování. Informace o trasování pomáhají určit, kde po provedení požadavku dojde k problémům.

Tip

Při testování operací rozhraní API rozšíření API Management umožňuje volitelné ladění zásad (dostupné na úrovni služby Developer).

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

Pokud už ji nepotřebujete, odeberte instanci API Management kliknutím pravým tlačítkem myši a výběrem možnosti Otevřít na portáluodstraňte službu API Management a její skupinu prostředků.

Případně můžete vybrat možnost Odstranit API Management a odstranit pouze instanci API Management (tato operace neodstraní svou skupinu prostředků).

Delete API Management instance from VS Code

Další kroky

V tomto kurzu jsme představili několik funkcí rozšíření API Management pro Visual Studio Code. Tyto funkce můžete použít k importu a správě rozhraní API. Naučili jste se:

  • Import rozhraní API do API Management
  • Úprava rozhraní API
  • Použití zásad API Management
  • Testování rozhraní API

Rozšíření API Management poskytuje další funkce pro práci s vašimi rozhraními API. Můžete například ladit zásady (dostupné ve vrstvě služby Developer) nebo vytvářet a spravovat pojmenované hodnoty.