Zjišťování a využívání rozhraní API pomocí rozšíření Azure API Center pro Visual Studio Code
Vývojáři rozhraní API ve vaší organizaci můžou zjišťovat a využívat rozhraní API ve vašem centru rozhraní API pomocí rozšíření Azure API Center pro Visual Studio Code. Rozšíření poskytuje následující funkce:
Zjišťování rozhraní API – Procházení rozhraní API v centru rozhraní API a zobrazení podrobností a dokumentace
Využívání rozhraní API – Generování klientů sady API SDK ve svém oblíbeném jazyce, včetně JavaScriptu, TypeScriptu, .NET, Pythonu a Javy, pomocí modulu Microsoft Kiota, který generuje sady SDK pro Microsoft Graph, GitHub a další.
Vývojáři rozhraní API můžou také využívat funkce v rozšíření k registraci rozhraní API v centru rozhraní API a zajištění zásad správného řízení rozhraní API.
Tip
Pokud chcete, aby vývojáři podnikových aplikací objevili rozhraní API v centralizované lokalitě, volitelně povolte katalog rozhraní API platformy pro vaše centrum rozhraní API v editoru Visual Studio Code. Katalog rozhraní API platformy je zobrazení inventáře rozhraní API jen pro čtení.
Požadavky
Jedno nebo více center rozhraní API ve vašem předplatném Azure.
- V současné době musíte mít přiřazenou roli Přispěvatel služeb Azure API Center nebo vyšší oprávnění v centru rozhraní API ke správě rozhraní API pomocí rozšíření.
- Rozšíření klienta REST – pro odesílání požadavků HTTP a zobrazení odpovědí přímo v editoru Visual Studio Code
- Rozšíření Microsoft Kiota – generování klientů rozhraní API
Nastavení rozšíření
Nainstalujte rozšíření Azure API Center pro Visual Studio Code z webu Visual Studio Code Marketplace. Nainstalujte další rozšíření uvedená v části Požadavky.
Poznámka:
Pokud je uvedeno, některé funkce jsou k dispozici pouze v předběžné verzi rozšíření Azure API Center. Při instalaci rozšíření z Marketplace editoru Visual Studio Code se můžete rozhodnout nainstalovat verzi nebo předběžnou verzi. Mezi těmito dvěma verzemi můžete kdykoli přepínat pomocí místní nabídky tlačítka Spravovat rozšíření v zobrazení Rozšíření.
V editoru Visual Studio Code na panelu aktivit na levé straně vyberte Centrum rozhraní API.
Pokud nejste přihlášení ke svému účtu Azure, vyberte Přihlásit se k Azure... a podle pokynů se přihlaste. Vyberte předplatné Azure s centrem rozhraní API (nebo centrem rozhraní API), ze kterého chcete zobrazit rozhraní API. Můžete také filtrovat konkrétní předplatná, pokud jich máte mnoho, ze kterých se chcete podívat.
Zjišťování rozhraní API
Prostředky centra rozhraní API se zobrazují ve stromovém zobrazení na levé straně. Rozbalením prostředku centra rozhraní API zobrazíte rozhraní API, verze, definice, prostředí a nasazení.
Vyhledejte rozhraní API v centru rozhraní API pomocí ikony hledání zobrazené v položce stromového zobrazení rozhraní API .
Zobrazit dokumentaci k rozhraní API
Dokumentaci k definici rozhraní API můžete zobrazit v centru rozhraní API a vyzkoušet operace rozhraní API. Tato funkce je dostupná jenom pro rozhraní API založená na OpenAPI ve vašem centru rozhraní API.
Rozbalte stromové zobrazení centra rozhraní API a zobrazte definici rozhraní API.
Klikněte pravým tlačítkem myši na definici a vyberte Otevřít dokumentaci k rozhraní API. Zobrazí se nová karta s uživatelským rozhraním Swagger pro definici rozhraní API.
Pokud chcete rozhraní API vyzkoušet, vyberte koncový bod, vyberte Vyzkoušet, zadejte požadované parametry a vyberte Spustit.
Poznámka:
V závislosti na rozhraní API možná budete muset zadat autorizační přihlašovací údaje nebo klíč rozhraní API, abyste mohli rozhraní API vyzkoušet.
Tip
Pomocí předběžné verze rozšíření můžete vygenerovat dokumentaci k rozhraní API v Markdownu, a to ve formátu, který se snadno udržuje a sdílí s koncovými uživateli. Klikněte pravým tlačítkem myši na definici a vyberte Vygenerovat Markdown.
Generování souboru HTTP
Soubor můžete zobrazit .http na základě definice rozhraní API v centru rozhraní API. Pokud je nainstalované rozšíření REST Client, můžete vytvořit adresář žádostí z editoru editoru Visual Studio Code. Tato funkce je dostupná jenom pro rozhraní API založená na OpenAPI ve vašem centru rozhraní API.
Rozbalte stromové zobrazení centra rozhraní API a zobrazte definici rozhraní API.
Klikněte pravým tlačítkem myši na definici a vyberte Vygenerovat soubor HTTP. Zobrazí se nová karta, která vykreslí dokument .http naplněný specifikací rozhraní API.
Pokud chcete vytvořit požadavek, vyberte koncový bod a vyberte Odeslat žádost.
Poznámka:
V závislosti na rozhraní API možná budete muset zadat autorizační přihlašovací údaje nebo klíč rozhraní API k provedení požadavku.
Generování klienta rozhraní API
Pomocí rozšíření Microsoft Kiota vygenerujte klienta rozhraní API pro váš oblíbený jazyk. Tato funkce je dostupná jenom pro rozhraní API založená na OpenAPI ve vašem centru rozhraní API.
- Rozbalte stromové zobrazení centra rozhraní API a zobrazte definici rozhraní API.
- Klikněte pravým tlačítkem myši na definici a vyberte Vygenerovat klienta rozhraní API. Zobrazí se podokno Generátor Kiota OpenAPI.
- Vyberte koncové body rozhraní API a operace HTTP, které chcete zahrnout do sad SDK.
- Vyberte Vygenerovat klienta rozhraní API.
Zadejte podrobnosti o konfiguraci názvu sady SDK, oboru názvů a výstupním adresáři.
Vyberte jazyk pro vygenerovanou sadu SDK.
Klient se vygeneruje.
Podrobnosti o použití rozšíření Kiota najdete v tématu Rozšíření Microsoft Kiota pro Visual Studio Code.
Specifikace rozhraní API pro export
Specifikaci rozhraní API můžete exportovat z definice a pak ji stáhnout jako soubor.
Export specifikace ve stromovém zobrazení rozšíření:
Rozbalte stromové zobrazení centra rozhraní API a zobrazte definici rozhraní API.
Klikněte pravým tlačítkem myši na definici a vyberte Exportovat dokument specifikace rozhraní API. Zobrazí se nová karta, která vykreslí dokument specifikace rozhraní API.
Specifikaci můžete také exportovat pomocí palety příkazů:
- Stisknutím klávesové zkratky Ctrl+Shift+P otevřete paletu příkazů.
- Vyberte Azure API Center: Export dokumentu specifikace rozhraní API.
- Proveďte výběry pro přechod na definici rozhraní API. Zobrazí se nová karta, která vykreslí dokument specifikace rozhraní API.