Share via

API's ontwerpen en ontwikkelen met behulp van de API Center-invoegtoepassing voor GitHub Copilot voor Azure

  • Artikel

De API Center-invoegtoepassing voor GitHub Copilot voor Azure (preview) versnelt het ontwerpen en ontwikkelen van nieuwe API's vanaf prompts in natuurlijke taal. Met AI-hulp die beschikbaar is via de API Center-invoegtoepassing in combinatie met de API Center VS Code-extensie, beschrijft u uw API en genereert u snel een OpenAPI-specificatie voor API-ontwikkeling die voldoet aan de standaarden van uw organisatie. Nadat u een compatibele specificatie hebt gegenereerd, kunt u de API registreren bij uw API-centrum.

Notitie

Deze functie is beschikbaar in de voorlopige versie van de API Center-extensie.

Vereisten

Extensie instellen

  1. Installeer de Azure API Center-extensie voor Visual Studio Code vanuit Visual Studio Code Marketplace. Installeer andere extensies die worden vermeld in de vereisten.

    Notitie

    Indien vermeld, zijn bepaalde functies alleen beschikbaar in de voorlopige versie van de Azure API Center-extensie. Wanneer u de extensie installeert vanuit Visual Studio Code Marketplace, kunt u ervoor kiezen om de releaseversie of een voorlopige versie te installeren. Schakel op elk gewenst moment tussen de twee versies met behulp van het contextmenu voor de knop Beheren van de extensie in de weergave Extensies.

  2. Selecteer API Center in Visual Studio Code in de activiteitenbalk aan de linkerkant.

    Schermopname van de API Center-extensie in de activiteitenbalk.

  3. Als u niet bent aangemeld bij uw Azure-account, selecteert u Aanmelden bij Azure...en volgt u de aanwijzingen om u aan te melden. Selecteer een Azure-abonnement met het API-centrum (of API-centra) waaruit u API's wilt weergeven. U kunt ook filteren op specifieke abonnementen als u er veel van kunt bekijken.

Aanvraag indienen bij de @azure agent

Volg deze stappen om een OpenAPI-specificatie te genereren met behulp van prompts voor natuurlijke taal met GitHub Copilot voor Azure:

  1. Stel desgewenst een actieve API-stijlgids in in de Azure API Center-extensie. Gebruik de sneltoets Ctrl+Shift+P om het opdrachtenpalet te openen. Type Azure API Center: Stel api-stijlgids in, maak een selectie en druk op Enter.

    Als er geen stijlgids is ingesteld, wordt de standaardregelset spectral:oas gebruikt. Meer informatie over api-specificatie linting met behulp van de API Center-extensie.

  2. Voer in het chatvenster een aanvraag in natuurlijke taal in bij de @azure agent om te beschrijven wat de API doet. Voorbeeld:

    @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 wordt mogelijk gemaakt door AI, dus verrassingen en fouten zijn mogelijk. Zie Veelgestelde vragen over Copilot voor meer informatie.

    De agent reageert met een OpenAPI-specificatiedocument.

    Schermopname die laat zien hoe u @azure-extensie gebruikt om een OpenAPI-specificatie te genereren vanaf een prompt.

  3. Controleer de gegenereerde uitvoer op nauwkeurigheid, volledigheid en naleving van uw API-stijlhandleiding.

    Verfijn de prompt indien nodig om de specificatie opnieuw te genereren of herhaal het proces met behulp van een andere stijlgids die u hebt ingesteld in de Azure API Center-extensie.

    Tip

    Effectieve prompts richten zich op de zakelijke vereisten van een API in plaats van implementatiedetails. Kortere prompts werken soms beter dan langere vragen.

  4. Wanneer deze voldoet aan uw vereisten, slaat u de gegenereerde OpenAPI-specificatie op in een bestand.

De API registreren in uw API-centrum

Gebruik de Azure API Center-extensie voor VS Code om de API in uw API-centrum te registreren op basis van het gegenereerde specificatiebestand. Nadat u de API hebt geregistreerd, kunt u de extensie gebruiken om de API-documentatie weer te geven, een HTTP-client te genereren, verdere linting en analyse uit te voeren, en meer.

  1. Selecteer in VS Code de knop Uw API registreren in API Center in het chatvenster of selecteer Azure API Center: API registreren in het opdrachtenpalet.

  2. Selecteer Handmatig.

  3. Selecteer het API-centrum waarmee u API's wilt registreren.

  4. Antwoordprompts met informatie zoals API-titel, type, versietitel, versielevenscyclus, definitietitel, specificatienaam en definitiebestand (specificatie) om de API-registratie te voltooien.

Nadat de API is geregistreerd, kunt u verschillende taken uitvoeren met behulp van de extensie. Bekijk bijvoorbeeld API-documentatie in de Swagger-gebruikersinterface:

  1. Vouw de structuurweergave van API Center uit om de definitie te selecteren voor de API-versie die u hebt geregistreerd.

  2. Klik met de rechtermuisknop op de definitie en selecteer Open API-documentatie. Er wordt een nieuw tabblad weergegeven met de Swagger-gebruikersinterface voor de API-definitie.

Schermopname van de Swagger-gebruikersinterface in de VS Code-extensie.

Gerelateerde inhoud