Sdílet prostřednictvím

Sestavení a registrace rozhraní API pomocí rozšíření Azure API Center pro Visual Studio Code

  • Článek

Vývojáři výrobců rozhraní API ve vaší organizaci můžou vytvářet a registrovat rozhraní API v inventáři centra API pomocí rozšíření Azure API Center pro Visual Studio Code. Vývojáři rozhraní API můžou:

  • Přidejte existující rozhraní API do centra rozhraní API jako jednorázovou operaci nebo integrujte vývojový kanál pro registraci rozhraní API jako součást pracovního postupu CI/CD.
  • Pomocí GitHub Copilotu vygenerujte nové specifikace OpenAPI z kódu rozhraní API.
  • K vytvoření nových specifikací OpenAPI použijte výzvy přirozeného jazyka s modulem plug-in API Center pro GitHub Copilot pro Azure.

Vývojáři uživatelů rozhraní API mohou také využívat funkce v rozšíření ke zjišťování a využívání rozhraní API v centru rozhraní API a zajištění zásad správného řízení rozhraní API.

Požadavky

Pro zadané scénáře jsou potřeba následující rozšíření editoru Visual Studio Code:

Nastavení

  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:

    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.

Registrace rozhraní API – krok za krokem

Následující kroky zaregistrují rozhraní API v centru rozhraní API jako jednorázovou operaci.

  1. K otevření palety příkazů použijte klávesovou zkratku Ctrl+Shift+P . Zadejte Azure API Center: Zaregistrujte rozhraní API a stiskněte Enter.
  2. Vyberte Ručně.
  3. Výběrem centra rozhraní API zaregistrujte rozhraní API.
  4. Odpovědi s informacemi, včetně názvu rozhraní API, typu, názvu verze, životního cyklu verze, názvu definice, názvu specifikace a definičního souboru pro dokončení registrace rozhraní API.

Rozhraní API se přidá do inventáře centra api.

Registrace rozhraní API – kanál CI/CD

Následující kroky zaregistrují rozhraní API v centru rozhraní API s kanálem CI/CD. Pomocí této možnosti přidejte předkonfigurovaný kanál GitHubu nebo Azure DevOps do aktivního pracovního prostoru editoru Visual Studio Code, který se spouští jako součást pracovního postupu CI/CD při každém potvrzení správy zdrojového kódu. Doporučujeme inventarizaci rozhraní API s centrem rozhraní API pomocí CI/CD zajistit, aby metadata rozhraní API, včetně specifikace a verze, zůstaly v aktuálním stavu ve vašem centru rozhraní API, protože se rozhraní API v průběhu času neustále vyvíjí.

  1. K otevření palety příkazů použijte klávesovou zkratku Ctrl+Shift+P . Zadejte Azure API Center: Zaregistrujte rozhraní API a stiskněte Enter.
  2. Vyberte CI/CD.
  3. V závislosti na preferovaném mechanismu správy zdrojového kódu vyberte GitHub nebo Azure DevOps. Aby bylo možné přidat kanál do pracovního prostoru, musíte otevřít pracovní prostor editoru Visual Studio Code pro rozšíření Azure API Center. Po přidání souboru dokončete kroky popsané v samotném souboru kanálu CI/CD a nakonfigurujte požadované proměnné prostředí a identitu. Při nasdílení změn do správy zdrojového kódu se rozhraní API zaregistruje ve vašem centru rozhraní API.

Přečtěte si další informace o nastavení pracovního postupu GitHub Actions pro registraci rozhraní API v centru rozhraní API.

Generování specifikace OpenAPI z kódu rozhraní API

Power of GitHub Copilot with the Azure API Center extension for Visual Studio Code to create an OpenAPI specification file from your API code. Klikněte pravým tlačítkem na kód rozhraní API, v možnostech vyberte Copilot a vyberte Vygenerovat dokumentaci k rozhraní API. GitHub Copilot vytvoří soubor specifikace OpenAPI.

Poznámka:

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

Animace znázorňující, jak použít GitHub Copilot k vygenerování specifikace OpenAPI z kódu

Po vygenerování souboru specifikace OpenAPI a kontrole přesnosti můžete rozhraní API zaregistrovat do centra rozhraní API pomocí příkazu Azure API Center: Registrace rozhraní API .

Generování specifikace OpenAPI pomocí výzev přirozeného jazyka

Modul plug-in API Center pro GitHub Copilot pro Azure (Preview) vám pomůže navrhnout nová rozhraní API počínaje výzvami přirozeného jazyka. S pomocí AI můžete rychle vygenerovat specifikaci OpenAPI pro vývoj rozhraní API, která vyhovuje standardům vaší organizace.

Poznámka:

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

  1. V případě potřeby nastavte aktivního průvodce stylem rozhraní API. 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.

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

    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 a zkontrolujte přesnost a dodržování předpisů v průvodci správným stylem rozhraní API. V případě potřeby vyřešte výzvu.

    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.

  5. Zaregistrujte rozhraní API ve svém centru rozhraní API. Na panelu chatu vyberte Zaregistrovat rozhraní API v Centru rozhraní API nebo vyberte Azure API Center: Zaregistrujte rozhraní API z palety příkazů a postupujte podle pokynů.

Související obsah