Esercitazione: Importare e pubblicare la prima API
SI APPLICA A: Tutti i livelli di Gestione API
Questa esercitazione illustra come importare un'API back-end specifica OpenAPI in formato JSON in Gestione API di Azure. Per questo esempio, si importa l'API Petstore open source.
Dopo l'importazione dell'API back-end in Gestione API, l'API di Gestione API diventa una facciata per l'API back-end. Gestione API consente di personalizzare la facciata in base alle proprie esigenze senza modificare l'API back-end. Per altre informazioni, vedere Trasformare e proteggere l'API.
In questa esercitazione apprenderai a:
- Importare un'API in Gestione API
- Testare l'API nel portale di Azure
Dopo l'importazione, è possibile gestire l'API nel portale di Azure.
Prerequisiti
- Acquisire familiarità con la terminologia di Gestione API di Azure.
- Creare un'istanza di Gestione API di Azure.
Passare all'istanza di Gestione API
Nel portale di Azure cercare e selezionare Servizi Gestione API.
Nella pagina Servizi Gestione API selezionare l'istanza di Gestione API.
Importare e pubblicare un'API back-end
Questa sezione illustra come importare e pubblicare un'API back-end Specifica OpenAPI.
Nel riquadro di spostamento a sinistra dell'istanza di Gestione API selezionare API.
Selezionare il riquadro OpenAPI.
Nella finestra Crea dalla specifica OpenAPI selezionare Completa.
Immettere i valori dalla tabella seguente.
È possibile impostare i valori dell'API durante la creazione o successivamente dalla scheda Impostazioni.
Impostazione valore Descrizione Specifica OpenAPI https://petstore3.swagger.io/api/v3/openapi.json Specifica il servizio back-end che implementa l'API e le operazioni supportate dall'API.
L'URL del servizio back-end viene visualizzato più avanti come URL del servizio Web nella pagina Impostazioni dell'API.
Dopo l'importazione, è possibile aggiungere, modificare, rinominare o eliminare operazioni della specifica.Includere i parametri di query nei modelli di operazione Selezionata (impostazione predefinita) Specifica se importare i parametri di query necessari nella specifica come parametri del modello in Gestione API. Nome visualizzato Dopo aver immesso l'URL della specifica OpenAPI, Gestione API compila questo campo in base al codice JSON. Nome visualizzato nel portale per sviluppatori. Nome Dopo aver immesso l'URL della specifica OpenAPI, Gestione API compila questo campo in base al codice JSON. Nome univoco per l'API. Descrizione Dopo aver immesso l'URL della specifica OpenAPI, Gestione API compila questo campo in base al codice JSON. Descrizione facoltativa per l'API. Schema URL HTTPS Protocolli che possono accedere all'API. Suffisso dell'URL dell'API petstore Suffisso aggiunto all'URL di base per il servizio Gestione API. Gestione API distingue le API in base al suffisso, quindi è necessario che questo sia univoco per ogni API di un editore specifico. Tag Tag per l'organizzazione delle API per la ricerca, il raggruppamento o il filtro. Prodotti Illimitato Associazione di una o più API. In alcuni livelli, Gestione API'istanza include due prodotti di esempio: Starter e Unlimited. Si pubblica un'API nel portale per sviluppatori associando l'API a un prodotto.
È possibile includere numerose API in un prodotto e offrirle sottoscrizioni al prodotto agli sviluppatori tramite il portale per sviluppatori. Per aggiungere questa API a un altro prodotto, digitare o selezionare il nome del prodotto. Ripetere questo passaggio per aggiungere l'API a più prodotti. È anche possibile aggiungere API ai prodotti in un secondo momento dalla pagina Impostazioni.
Per altre informazioni sui prodotti, vedere Creare e pubblicare un prodotto.Gateway Gestito Gateway API che espongono l'API. Questo campo è disponibile solo nei servizi di livello Developer e Premium.
Gestito indica il gateway integrato nel servizio Gestione API e ospitato da Microsoft in Azure. I gateway self-hosted sono disponibili solo nei livelli di servizio Premium e Developer e possono essere distribuiti in locale o in altri cloud.
Se non è selezionato alcun gateway, l'API non sarà disponibile e le richieste API non verranno eseguite.Assegnare un numero di versione a questa API? Selezionare o deselezionare Per altre informazioni, vedere Pubblicare più versioni dell'API. Selezionare Crea per creare l'API.
In caso di problemi durante l'importazione della definizione API, vedere l'elenco delle restrizioni e dei problemi noti.
Testare la nuova API nel portale di Azure
È possibile chiamare le operazioni API direttamente dal portale di Azure, che rappresenta una soluzione pratica per visualizzare e testare le operazioni. Nella console di test del portale, per impostazione predefinita le API vengono chiamate usando una chiave della sottoscrizione a tutti gli accessi integrata. È inoltre possibile testare le chiamate API usando una chiave della sottoscrizione associata a un prodotto.
Nel riquadro di spostamento sinistro dell'istanza di Gestione API selezionare API>Swagger Petstore.
Selezionare la scheda Test e quindi selezionare Trova animali domestici per stato. La pagina mostra il parametro Query di stato. Selezionare uno dei valori disponibili, ad esempio in sospeso. È anche possibile aggiungere qui parametri di query e intestazioni.
Nella sezione richiesta HTTP l'intestazione Ocp-Apim-Subscription-Key viene compilata automaticamente, ed è possibile visualizzarla se si seleziona l'icona con l’occhio.
Selezionare Invia.
Il back-end risponde con 200 OK e alcuni dati.
Passaggi successivi
Questa esercitazione ha descritto come:
- Importare la prima API
- Testare l'API nel portale di Azure
Passare all'esercitazione successiva per imparare a creare e pubblicare un prodotto: