kurz: použití rozšíření API Management pro Visual Studio Code 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 Visual Studio Code prostředí můžete importovat, aktualizovat, testovat a spravovat rozhraní api.

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

Úvod k dalším funkcím API Management najdete v kurzech API Management pomocí Azure Portal.

Požadavky

• Vysvětlení terminologie služby Azure API Management
• ujistěte se, že máte nainstalované Visual Studio Code a nejnovější rozšíření Azure API Management pro Visual Studio Code
• Vytvoření instance API Management

Import rozhraní API

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

1. v Visual Studio Code na řádku aktivity vyberte ikonu Azure.
2. V podokně Průzkumník rozbalte instanci API Management, kterou jste vytvořili.
3. Klikněte pravým tlačítkem na rozhraní API a vyberte odkaz importovat z 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řepošle požadavky na tuto adresu.
   2. Název rozhraní API, jako je například demo-konferenční rozhraní API, které je v instanci API Management jedinečné. Tento název může obsahovat jenom písmena, číslice a spojovníky. První a poslední znak musí být alfanumerický. Tento název se používá v cestě pro volání rozhraní API.

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

Úprava rozhraní API

Rozhraní API můžete upravit v Visual Studio Code. Pokud například chcete odebrat protokol http , který se používá pro přístup k rozhraní API, upravte správce prostředků popisu JSON rozhraní API v okně editoru. Pak vyberte soubor > Uložit.

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 požadované změny a pak vyberte soubor > Uložit.

Použití zásad pro rozhraní API

API Management poskytuje zásady , které můžete nakonfigurovat pro vaše rozhraní API. Zásady představují kolekci příkazů, které se postupně provádí na základě požadavku nebo odezvy z rozhraní API. Zásady můžou být globální, které se vztahují na všechna rozhraní API ve vaší instanci API Management, nebo můžou být vymezené na konkrétní rozhraní API nebo operaci rozhraní API.

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

1. V podokně Průzkumník vyberte v části ukázková konference – rozhraní API , které jste naimportovali, zásadu . V okně editoru se otevře soubor zásad. Tento soubor nakonfiguruje zásady pro všechny operace v rozhraní API.

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

   [...]
   <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>
   [...]
   

   • První set-header zásada přidá vlastní hlavičku odpovědi pro demonstrační účely.
   • Druhá set-header zásada odstraní hlavičku X-The-by , pokud existuje. Tato hlavička může odhalit aplikační rozhraní používané v back-endu rozhraní API a vydavatelé ji často odstraní.
   • redirect-content-urlsZásady přepisují odkazy (masky) v těle odpovědi tak, aby odkazovaly na ekvivalentní odkazy prostřednictvím API Management brány.

3. Soubor uložte. pokud se zobrazí výzva, vyberte Upload , aby se soubor nahrál do cloudu.

Testování rozhraní API

Získat klíč předplatného

K otestování importovaného rozhraní API, které jste naimportovali, a zásad, které jsou aplikovány, 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.

   

Testování operace rozhraní API

1. V podokně Průzkumník rozbalte uzel Operations v části demo-konferenční rozhraní API , které jste naimportovali.
2. Vyberte operaci, jako například Getspeakers, a potom klikněte pravým tlačítkem na operaci a vyberte testovací operaci.
3. V okně editoru vedle klíče OCP-APIM-Subscription-Key nahraďte {{SubscriptionKey}} klíč předplatného, který jste zkopírovali.
4. Vyberte Odeslat žádost.

Po úspěšném dokončení požadavku back-end odpoví s 200 OK a dalšími daty.

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

• Vlastní hlavička je přidána do odpovědi.
• Hlavička X-The-by se v odpovědi nezobrazuje.
• Adresy URL back-endu rozhraní API jsou v tomto případě přesměrovány na bránu API Management 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, získáte výběrem odkazu, který se zobrazí vedle OCP-APIM-Trace-Location.

Soubor JSON v tomto umístění obsahuje informace o příchozím, back-endu a odchozím trasování, abyste mohli určit, kde k problémům dochází po provedení žádosti.

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

Pokud už je nepotřebujete, odeberte instanci API Management tak, že kliknete pravým tlačítkem a vyberete otevřít na portálu a odstraníte API Management službu a její skupinu prostředků.

Alternativně můžete vybrat možnost odstranit API Management a odstranit pouze instanci API Management (Tato operace neodstraní skupinu prostředků).

Další kroky

v tomto kurzu jste zavedli několik funkcí rozšíření API Management pro Visual Studio Code, které můžete použít k importu a správě rozhraní api. Naučili jste se:

Rozšíření API Management poskytuje další funkce pro práci s rozhraními API. Například zásady ladění (k dispozici v úrovni Vývojářské služby) nebo vytváření a Správa pojmenovaných hodnot.