Esercizio - Creare un'API back-end

  • 15 minuti

In questo esercizio viene illustrato come eseguire le azioni seguenti:

  • Creare un'istanza di Gestione API
  • Importare un'API
  • Configurare le impostazioni di back-end
  • Testare l'API

Prerequisiti

  • Un account Azure con una sottoscrizione attiva. Se non è ancora disponibile alcuna sottoscrizione, è possibile registrarsi per una valutazione gratuita all'indirizzo https://azure.com/free.

Accedere ad Azure

  1. Accedere al portale di Azure e aprire Cloud Shell.

    The location of Cloud Shell launch button.

  2. Dopo l'apertura della shell, assicurarsi che sia selezionato l'ambiente Bash.

    Selecting the Bash environment.

Creare un'istanza di Gestione API

  1. Impostare alcune variabili per i comandi dell'interfaccia della riga di comando da usare per ridurre la quantità di digitazioni. Sostituire <myLocation> con un'area significativa per l'utente. Il nome di Gestioni API deve essere un nome univoco globale e lo script seguente genera una stringa casuale. Sostituire <myEmail> con un indirizzo di posta elettronica a cui è possibile accedere.

    myApiName=az204-apim-$RANDOM
myLocation=<myLocation>
myEmail=<myEmail>

  2. Crea un gruppo di risorse. I comandi seguenti creeranno un gruppo di risorse denominato az204-apim-rg.

    az group create --name az204-apim-rg --location $myLocation

  3. Creare un'istanza di Gestione API. Il comando az apim create viene usato per creare l'istanza. L'opzione --sku-name Consumption viene usata per velocizzare il processo per la procedura dettagliata.

    az apim create -n $myApiName \
    --location $myLocation \
    --publisher-email $myEmail  \
    --resource-group az204-apim-rg \
    --publisher-name AZ204-APIM-Exercise \
    --sku-name Consumption

    Nota

    L'operazione deve essere completata in circa cinque minuti.

Importare un'API back-end

Questa sezione illustra come importare e pubblicare un'API back-end Specifica OpenAPI.

  1. Nel portale di Azure cercare e selezionare Servizi Gestione API.

  2. Nella schermata Gestione API selezionare l'istanza di Gestione API creata.

  3. Selezionare API nel riquadro di spostamento del servizio Gestione API.

    Select APIs in the service navigation pane.

  4. Selezionare OpenAPI dall'elenco e scegliere Full nella finestra popup.

    The OpenAPI dialog box. Fields are detailed in the following table.

    Per compilare il modulo, usare i valori della tabella seguente. È possibile lasciare in tutti i campi non indicati il valore predefinito.

    Impostazione valore Descrizione
    Specifica OpenAPI https://conferenceapi.azurewebsites.net?format=json Fa riferimento al servizio che implementa l'API, le richieste vengono inoltrate a questo indirizzo. La maggior parte delle informazioni necessarie nel modulo viene popolata automaticamente dopo l'immissione.
    Nome visualizzato Demo Conference API Questo nome viene visualizzato nel portale per sviluppatori.
    Nome demo-conference-api Fornisce un nome univoco per l'API.
    Descrizione Popolato automaticamente Fornisce una descrizione facoltativa dell'API.
    Suffisso dell'URL dell'API conference Il suffisso viene aggiunto all'URL di base del servizio Gestione API. Gestione API distingue le API in base al suffisso, quindi è necessario che questo sia univoco per ciascuna API di un editore specifico.

  5. Seleziona Crea.

Configurare le impostazioni di back-end

È stata creata l'API Demo Conference ed è necessario specificare un back-end.

  1. Selezionare Impostazioni nel pannello a destra e immettere https://conferenceapi.azurewebsites.net/ nel campo URL del servizio Web.

  2. Deselezionare la casella di controllo La sottoscrizione è obbligatoria.

    Specify the backend URL for the API.

  3. Seleziona Salva.

Testare l'API

Ora che l'API è stata importata e il back-end configurato è il momento di testare l'API.

  1. Selezionare Verifica.

    Select test in the right pane.

  2. Selezionare GetSpeakers. Nella pagina vengono visualizzati i Parametri di query e le Intestazioni, se presenti. Il campo Ocp-Apim-Subscription-Key viene compilato automaticamente per la chiave di sottoscrizione associata a questa API.

  3. Selezionare Invia.

    Il back-end risponde con 200 OK e alcuni dati.

Pulire le risorse di Azure

Al termine della creazione delle risorse in questo esercizio, è possibile usare il comando seguente per eliminare il gruppo di risorse e tutte le risorse correlate.

az group delete --name az204-apim-rg