Individuare e usare le API con l'estensione Centro API di Azure per Visual Studio Code
Gli sviluppatori di API dell'organizzazione possono individuare e usare le API nel centro API usando l'estensione Centro API di Azure per Visual Studio Code. L'estensione offre le funzionalità indicate di seguito:
Individuare le API: esplorare le API nel centro API e visualizzarne i dettagli e la documentazione.
Usare le API: generare client API SDK nel linguaggio preferito, tra cui JavaScript, TypeScript, .NET, Python e Java, usando il motore Microsoft Kiota che genera SDK per Microsoft Graph, GitHub e altro ancora.
Gli sviluppatori di API possono anche sfruttare le funzionalità nell'estensione per registrare le API nel Centro API e garantire la governance delle API.
Suggerimento
Se si vuole che gli sviluppatori di app aziendali rilevino le API in una posizione centralizzata, facoltativamente abilitare un catalogo API della piattaforma per il centro API in Visual Studio Code. Il catalogo API della piattaforma è una visualizzazione di sola lettura dell'inventario API.
Prerequisiti
Uno o più centri API nella sottoscrizione di Azure.
- Attualmente è necessario assegnare il ruolo Collaboratore al servizio Del Centro API di Azure o autorizzazioni superiori per un centro API per gestire le API con l'estensione .
- Estensione client REST: per inviare richieste HTTP e visualizzare direttamente le risposte in Visual Studio Code
- Estensione Microsoft Kiota: per generare client API
Attrezzaggio
Installare l'estensione Centro API di Azure per Visual Studio Code da Visual Studio Code Marketplace. Installare altre estensioni in base alle esigenze.
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.
In Visual Studio Code, nella barra delle attività a sinistra selezionare Centro API.
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.
Individuare le API
Le risorse del centro API vengono visualizzate nella visualizzazione albero sul lato sinistro. Espandere una risorsa centro API per visualizzare API, versioni, definizioni, ambienti e distribuzioni.
Cercare le API all'interno di un Centro API usando l'icona di ricerca visualizzata nell'elemento della visualizzazione albero Apis.
Visualizzare la documentazione relativa alle API
È possibile visualizzare la documentazione per una definizione di API nel centro API e provare le operazioni API. Questa funzionalità è disponibile solo per le API basate su OpenAPI nel centro API.
Espandere la visualizzazione della struttura ad albero del Centro API per visualizzare una definizione API.
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.
Per provare l'API, selezionare un endpoint, selezionare Prova, immettere i parametri obbligatori e selezionare Esegui.
Nota
A seconda dell'API, potrebbe essere necessario fornire le credenziali di autorizzazione o una chiave API per provare l'API.
Suggerimento
Usando la versione non definitiva dell'estensione, è possibile generare la documentazione dell'API in Markdown, un formato facile da gestire e condividere con gli utenti finali. Fare clic con il pulsante destro del mouse sulla definizione e scegliere Genera markdown.
Generare un file HTTP
È possibile visualizzare un file .http basato sulla definizione dell'API nel centro API. Se l'estensione client REST è installata, è possibile effettuare richieste directory dall'editor di Visual Studio Code. Questa funzionalità è disponibile solo per le API basate su OpenAPI nel centro API.
Espandere la visualizzazione della struttura ad albero del Centro API per visualizzare una definizione API.
Fare clic con il pulsante destro del mouse sulla definizione e scegliere Genera file HTTP. Viene visualizzata una nuova scheda che esegue il rendering di un documento .http popolato dalla specifica dell'API.
Per effettuare una richiesta, selezionare un endpoint e selezionare Invia richiesta.
Nota
A seconda dell'API, potrebbe essere necessario fornire le credenziali di autorizzazione o una chiave API per effettuare la richiesta.
Generare il client API
Usare l'estensione Microsoft Kiota per generare un client API per la lingua preferita. Questa funzionalità è disponibile solo per le API basate su OpenAPI nel centro API.
- Espandere la visualizzazione della struttura ad albero del Centro API per visualizzare una definizione API.
- Fare clic con il pulsante destro del mouse sulla definizione e scegliere Genera client API. Viene visualizzato il riquadro Kiota OpenAPI Generator.
- Selezionare gli endpoint API e le operazioni HTTP da includere negli SDK.
- Selezionare Genera client API.
Immettere i dettagli di configurazione relativi al nome dell'SDK, allo spazio dei nomi e alla directory di output.
Selezionare la lingua per l'SDK generato.
Il client viene generato.
Per informazioni dettagliate sull'uso dell'estensione Kiota, vedere Estensione Microsoft Kiota per Visual Studio Code.
Esportare la specifica dell'API
È possibile esportare una specifica API da una definizione e quindi scaricarla come file.
Per esportare una specifica nella visualizzazione albero dell'estensione:
Espandere la visualizzazione della struttura ad albero del Centro API per visualizzare una definizione API.
Fare clic con il pulsante destro del mouse sulla definizione e scegliere Esporta documento specifica API. Viene visualizzata una nuova scheda che esegue il rendering di un documento di specifica dell'API.
È anche possibile esportare una specifica usando il riquadro comandi:
- Digitare il tasto di scelta rapida CTRL+MAIUSC+P per aprire il riquadro comandi.
- Selezionare Centro API di Azure: Esporta documento specifica API.
- Effettuare selezioni per passare a una definizione API. Viene visualizzata una nuova scheda che esegue il rendering di un documento di specifica dell'API.