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

Modul plug-in API Center pro GitHub Copilot pro Azure zrychluje návrh a vývoj nových rozhraní API počínaje výzvami přirozeného jazyka. Pomoc s AI je k dispozici prostřednictvím modulu plug-in API Center v kombinaci s rozšířením API Center pro Visual Studio Code. Stačí popsat rozhraní API a rychle vygenerovat 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.

Požadavky

Nastavení rozšíření

Rozšíření nastavte následujícím postupem:

  1. Nainstalujte rozšíření Azure API Center pro Visual Studio Code z webu Visual Studio Code Marketplace. Podle potřeby nainstalujte další rozšíření.

    Poznámka:

    Zápis [PREVIEW] označuje funkce dostupné pouze v předběžné verzi rozšíření Azure API Center. Když nainstalujete rozšíření z Visual Studio Code Marketplace, můžete nainstalovat vydanou verzi nebo předběžnou verzi, pokud je k dispozici. Pokud chcete přepínat mezi nainstalovanými verzemi, vyberte tlačítko Spravovat rozšíření (ikona ozubeného kola) v zobrazení Rozšíření v editoru Visual Studio Code.

  2. V editoru Visual Studio Code na panelu aktivit vyberte Centrum rozhraní API:

    Snímek obrazovky s ikonou rozšíření API Center na panelu aktivit editoru Visual Studio Code

  3. Pokud nejste přihlášení ke svému účtu Azure, vyberte Přihlásit se k Azure a podle pokynů se přihlaste.

  4. Vyberte předplatné Azure s centrem nebo centry rozhraní API, která obsahují rozhraní API, která chcete zobrazit. Pokud máte více účtů, můžete filtrovat podle konkrétních předplatných.

Vytvořte požadavek k agentovi @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 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. Zkontrolujte vygenerovaný výstup pro jeho přesnost, úplnost a dodržování stylového průvodce pro API.

    Pokud je to nutné, upřesněte výzvu pro opětovné vygenerování specifikace nebo zopakujte proces s použitím jiné stylové příručky, kterou jste nastavili v rozšíření Azure API Center.

    Návod

    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.

Zaregistrujte rozhraní API ve vašem centru rozhraní API

Pomocí rozšíření Azure API Center pro Visual Studio Code zaregistrujte API ve vašem centru 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 Visual Studio Code vyberte v panelu chatu tlačítko Registrujte rozhraní API v API Centru, nebo vyberte z palety příkazů Azure API Centrum: Zaregistrovat rozhraní API.

  2. Vyberte Ručně.

  3. Vyberte centrum rozhraní API, ve které chcete zaregistrovat rozhraní API.

  4. Odpovězte na výzvy informacemi, které zahrnují název rozhraní API, typ, název verze, životní cyklus verze, název definice, název specifikace a soubor 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.

Screenshot uživatelského rozhraní Swaggeru v rozšíření Azure API Center pro Visual Studio Code.

Související obsah

  • Last updated on