Sdílet prostřednictvím

Návrh a vývoj rozhraní API pomocí modulu plug-in API Center pro GitHub Copilot pro Azure

  • Článek

Modul plug-in API Center pro GitHub Copilot pro Azure (Preview) zrychluje návrh a vývoj nových rozhraní API počínaje výzvami přirozeného jazyka. Díky pomoci s AI dostupnou prostřednictvím modulu plug-in API Center v kombinaci s rozšířením API Center VS Code jednoduše popište své rozhraní API a rychle vygenerujte specifikaci OpenAPI pro vývoj rozhraní API, která vyhovuje standardům vaší organizace. Po vygenerování specifikace vyhovující předpisům můžete rozhraní API zaregistrovat ve svém centru rozhraní API.

Poznámka:

Tato funkce je dostupná v předběžné verzi rozšíření API Center.

Požadavky

Nastavení rozšíření

  1. 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í.

  2. V editoru Visual Studio Code na panelu aktivit na levé straně vyberte Centrum rozhraní API.

    Snímek obrazovky s rozšířením API Center na panelu aktivit

  3. 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.

Provedení požadavku na agenta @azure

Pokud chcete vygenerovat specifikaci OpenAPI pomocí výzev přirozeného jazyka pomocí GitHub Copilotu pro Azure, postupujte takto:

  1. V případě potřeby nastavte aktivního průvodce stylem rozhraní API v rozšíření Azure API Center. K otevření palety příkazů použijte klávesovou zkratku Ctrl+Shift+P . Zadejte Azure API Center: Nastavte průvodce stylem rozhraní API, proveďte výběr a stiskněte Enter.

    Pokud není nastaven žádný průvodce stylem, použije se výchozí spectral:oas sada pravidel. Přečtěte si další informace o lintování specifikace rozhraní API pomocí rozšíření API Center.

  2. Na panelu chatu požádejte agenta o požadavek v přirozeném @azure jazyce, který popisuje, co rozhraní API dělá. Příklad:

    @azure Generate an OpenAPI spec: An API that allows customers to pay for an order using various payment methods such as cash, checks, credit cards, and debit cards. Check that there are no duplicate keys.

    Copilot využívá AI, takže překvapení a chyby jsou možné. Další informace naleznete v části Nejčastější dotazy ke copilotu.

    Agent odpoví dokumentem specifikace OpenAPI.

    Snímek obrazovky znázorňující, jak pomocí rozšíření @azure vygenerovat specifikaci OpenAPI z výzvy

  3. Projděte si vygenerovaný výstup, abyste získali přesnost, úplnost a dodržování předpisů v průvodci stylem rozhraní API.

    V případě potřeby vyřešte výzvu k opětovnému vygenerování specifikace nebo opakujte proces pomocí jiného průvodce stylem, který jste nastavili v rozšíření Azure API Center.

    Tip

    Efektivní výzvy se zaměřují na obchodní požadavky rozhraní API, nikoli na podrobnosti implementace. Kratší výzvy někdy fungují lépe než delší.

  4. Když splňuje vaše požadavky, uložte vygenerovanou specifikaci OpenAPI do souboru.

Registrace rozhraní API v centru rozhraní API

Pomocí rozšíření Azure API Center pro VS Code zaregistrujte rozhraní API v centru rozhraní API z vygenerovaného souboru specifikace. Po registraci rozhraní API můžete pomocí rozšíření zobrazit dokumentaci k rozhraní API, vygenerovat klienta HTTP, provést další lintování a analýzu a další.

  1. Ve VS Code vyberte na panelu chatu tlačítko Zaregistrovat rozhraní API v Centru rozhraní API nebo vyberte Azure API Center: Zaregistrovat rozhraní API z palety příkazů.

  2. Vyberte Ručně.

  3. Výběrem centra rozhraní API zaregistrujte rozhraní API.

  4. Odpovědi zobrazí výzvu s informacemi, včetně názvu rozhraní API, typu, názvu verze, životního cyklu verze, názvu definice, názvu specifikace a souboru definice (specifikace) pro dokončení registrace rozhraní API.

Po registraci rozhraní API můžete pomocí rozšíření provádět různé úlohy. Například zobrazení dokumentace k rozhraní API v uživatelském rozhraní Swagger:

  1. Rozbalte stromové zobrazení centra rozhraní API a vyberte definici pro verzi rozhraní API, kterou jste zaregistrovali.

  2. 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.

Snímek obrazovky s uživatelským rozhraním Swagger v rozšíření VS Code

Související obsah