Condividi tramite

Progettare e sviluppare API usando il plug-in Centro API per GitHub Copilot per Azure

  • Articolo

Il plug-in Centro API per GitHub Copilot per Azure (anteprima) accelera la progettazione e lo sviluppo di nuove API a partire dai prompt del linguaggio naturale. Con l'assistenza per l'intelligenza artificiale disponibile tramite il plug-in Di Centro API combinato con l'estensione API VS Code, è sufficiente descrivere l'API e generare rapidamente una specifica OpenAPI per lo sviluppo di API conforme agli standard dell'organizzazione. Dopo aver generato una specifica conforme, è possibile registrare l'API con il centro API.

Nota

Questa funzionalità è disponibile nella versione non definitiva dell'estensione Centro API.

Prerequisiti

Configurazione dell'estensione

  1. Installare l'estensione Centro API di Azure per Visual Studio Code da Visual Studio Code Marketplace. Installare altre estensioni elencate nei prerequisiti.

    Nota

    Se indicato, alcune funzionalità sono disponibili solo nella versione non definitiva dell'estensione Centro API di Azure. Quando si installa l'estensione dal Marketplace di Visual Studio Code, è possibile scegliere di installare la versione di rilascio o una versione non definitiva. È possibile passare da una versione all'altra in qualsiasi momento usando il menu di scelta rapida Gestisci dell'estensione nella visualizzazione Estensioni.

  2. In Visual Studio Code, nella barra delle attività a sinistra selezionare Centro API.

    Screenshot dell'estensione Centro API nella barra delle attività.

  3. Se non si è connessi all'account Azure, selezionare Accedi ad Azure...e seguire le istruzioni per accedere. Selezionare una sottoscrizione di Azure con il centro API (o i centri API) da cui si vogliono visualizzare le API. È anche possibile filtrare in base a sottoscrizioni specifiche se sono disponibili molte opzioni da visualizzare.

Effettuare una richiesta all'agente @azure

Seguire questa procedura per generare una specifica OpenAPI usando i prompt del linguaggio naturale con GitHub Copilot per Azure:

  1. Se necessario, impostare una guida di stile api attiva nell'estensione Centro API di Azure. Usare il tasto di scelta rapida CTRL+MAIUSC+P per aprire il riquadro comandi. Digitare Centro API di Azure: Impostare la Guida di stile api, effettuare una selezione e premere INVIO.

    Se non è impostata alcuna guida di stile, viene usato il set di regole predefinito spectral:oas . Altre informazioni sul linting delle specifiche API con l'estensione centro API.

  2. Nel pannello della chat effettuare una richiesta in linguaggio naturale all'agente @azure per descrivere le operazioni dell'API. Esempio:

    @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 è alimentato dall'IA, quindi sono possibili sorprese ed errori. Per altre informazioni, vedere Domande frequenti su Copilot.

    L'agente risponde con un documento di specifica OpenAPI.

    Screenshot che mostra come usare @azure'estensione per generare una specifica OpenAPI da un prompt.

  3. Esaminare l'output generato per verificare l'accuratezza, la completezza e la conformità con la guida allo stile dell'API.

    Ridefinire la richiesta se necessario per rigenerare la specifica o ripetere il processo usando una guida di stile diversa impostata nell'estensione Centro API di Azure.

    Suggerimento

    Le richieste effettive si concentrano sui requisiti aziendali di un'API anziché sui dettagli di implementazione. Le richieste più brevi a volte funzionano meglio di quelle più lunghe.

  4. Quando soddisfa i requisiti, salvare la specifica OpenAPI generata in un file.

Registrare l'API nel centro API

Usare l'estensione Centro API di Azure per VS Code per registrare l'API nel centro API dal file di specifica generato. Dopo aver registrato l'API, è possibile usare l'estensione per visualizzare la documentazione dell'API, generare un client HTTP, eseguire altre operazioni di linting e analisi e altro ancora.

  1. In VS Code selezionare Registra l'API nel centro API nel pannello della chat oppure selezionare Centro API di Azure: Registra API dal riquadro comandi.

  2. Selezionare Manuale.

  3. Selezionare il centro API con cui registrare le API.

  4. Risposte alle richieste con informazioni che includono il titolo dell'API, il tipo, il titolo della versione, il ciclo di vita della versione, il titolo della definizione, il nome della specifica e il file di definizione (specifica) per completare la registrazione api.

Dopo aver registrato l'API, è possibile eseguire varie attività usando l'estensione . Ad esempio, visualizzare la documentazione dell'API nell'interfaccia utente di Swagger:

  1. Espandere la visualizzazione albero centro API per selezionare la definizione per la versione dell'API registrata.

  2. Fare clic con il pulsante destro del mouse sulla definizione e scegliere Apri documentazione API. Viene visualizzata una nuova scheda con l'interfaccia utente di Swagger per la definizione dell'API.

Screenshot dell'interfaccia utente di Swagger nell'estensione VS Code.

Contenuto correlato