Esercitazione: Simulare le risposte dell'API

SI APPLICA A: Tutti i livelli di Gestione API

Le API back-end vengono importate in un'API di Gestione API o create e gestite manualmente. I passaggi di questa esercitazione illustrano come:

• Usare Gestione API per creare un'API HTTP vuota
• Gestire manualmente un'API HTTP
• Impostare un criterio in un'API in modo che restituisca una risposta fittizia

Questo metodo consente agli sviluppatori di proseguire con l'implementazione e il test dell'istanza di Gestione API anche se il back-end non è disponibile per inviare risposte reali.

La possibilità di simulare le risposte è utile in molti scenari:

• Quando la facciata dell'API viene progettata prima e l'implementazione del back-end viene eseguita in seguito o quando il back-end viene sviluppato in parallelo.
• Quando il back-end è temporaneamente non operativo o non è possibile ridimensionarlo.

In questa esercitazione apprenderai a:

• Creare un'API di test
• Aggiungere un'operazione all'API di test
• Abilitare la simulazione della risposta
• Testare l'API fittizia

Prerequisiti

• Acquisire familiarità con la terminologia di Gestione API di Azure.
• Comprendere il concetto di criteri in Gestione API di Azure.
• Completare la guida introduttiva seguente: Creare un'istanza di Gestione API di Azure.

Creare un'API di test

I passaggi descritti in questa sezione illustrano come creare un'API HTTP senza back-end.

1. Accedere al portale di Azure, quindi passare all'istanza di Gestione API.

2. Selezionare API>+ Aggiungi API>Riquadro HTTP.

   

3. Nella finestra Crea un'API HTTP selezionare Completa.

4. Immettere Test API in Nome visualizzato.

5. Selezionare Senza limiti per Prodotti.

6. Assicurarsi che Gestito sia selezionato per Gateway.

7. Seleziona Crea.

   

Aggiungere un'operazione all'API di test

Un'API espone una o più operazioni. In questa sezione si aggiungerà un'operazione all'API HTTP creata. La chiamata all'operazione al termine dei passaggi descritti in questa sezione genera un errore. Dopo aver completato i passaggi descritti nella sezione Abilitare la simulazione della risposta, non verranno visualizzati errori.

Portale

1. Selezionare l'API creata nel passaggio precedente.

2. Selezionare + Aggiungi operazione.

3. Nella finestra Front-end immettere i valori seguenti.

   

   Impostazione	valore	Descrizione
   Nome visualizzato	Test call	Nome visualizzato nel portale per sviluppatori.
   URL (verbo HTTP)	GET	Selezionare uno dei verbi HTTP predefiniti.
   URL	test/	Percorso URL per l'API.
   Descrizione		Descrizione facoltativa dell'operazione usata per fornire la documentazione necessaria agli sviluppatori che usano questa API nel portale per sviluppatori.

4. Selezionare la scheda Risposte, sotto i campi URL, Nome visualizzato e Descrizione. In questa scheda immettere le impostazioni per definire schemi, esempi, tipi di contenuto e codici di stato della risposta.

5. Selezionare + Aggiungi risposta e selezionare 200 OK dall'elenco.

   

6. Sotto l'intestazione Rappresentazioni a destra selezionare + Aggiungi rappresentazione.

7. Immettere application/json nella casella di ricerca e selezionare il tipo di contenuto application/json.

8. Nella casella di testo Sample (Esempio) immettere { "sampleField" : "test" }.

9. Seleziona Salva.

   

Sebbene non sia richiesto per questo esempio, è possibile configurare più impostazioni per un'operazione API in altre schede, ad esempio:

Scheda	Descrizione
Query	Consente di aggiungere parametri di query. Oltre al nome e alla descrizione, è possibile specificare anche i valori che da assegnare a un parametro di query. È possibile contrassegnare uno dei valori come predefinito (facoltativo).
Richiedi	Consente di definire schemi, esempi e tipi di contenuto della richiesta.

Interfaccia della riga di comando di Azure

Per iniziare a usare l'interfaccia della riga di comando di Azure:

• Usare l'ambiente Bash in Azure Cloud Shell. Per altre informazioni, vedere la Avvio rapido di Bash in Azure Cloud Shell.

  

• Se si preferisce eseguire i comandi di riferimento dell'interfaccia della riga di comando in locale, installare l'interfaccia della riga di comando di Azure. Per l'esecuzione in Windows o macOS, è consigliabile eseguire l'interfaccia della riga di comando di Azure in un contenitore Docker. Per altre informazioni, vedere Come eseguire l'interfaccia della riga di comando di Azure in un contenitore Docker.

  • Se si usa un'installazione locale, accedere all'interfaccia della riga di comando di Azure con il comando az login. Per completare il processo di autenticazione, seguire la procedura visualizzata nel terminale. Per altre opzioni di accesso, vedere Accedere tramite l'interfaccia della riga di comando di Azure.

  • Quando richiesto, al primo utilizzo installare l'estensione dell'interfaccia della riga di comando di Azure. Per altre informazioni sulle estensioni, vedere Usare le estensioni con l'interfaccia della riga di comando di Azure.

  • Eseguire az version per trovare la versione e le librerie dipendenti installate. Per eseguire l'aggiornamento alla versione più recente, eseguire az upgrade.

Per aggiungere un'operazione all'API di test, eseguire il comando az apim api operation create:

az apim api operation create --resource-group apim-hello-word-resource-group \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name apim-hello-world 

Eseguire il comando az apim api operation list per visualizzare tutte le operazioni per un'API:

az apim api operation list --resource-group apim-hello-word-resource-group \
    --api-id test-api --service-name apim-hello-world --output table

Per rimuovere un'operazione, usare il comando az apim api operation delete. Ottenere l'ID operazione dal passaggio precedente.

az apim api operation delete --resource-group apim-hello-word-resource-group \
    --api-id test-api --operation-id 00000000000000000000000000000000 \
    --service-name apim-hello-world

Mantenere questa operazione pronta per l'uso per il resto dell'articolo.

Abilitare la simulazione della risposta

1. Selezionare l'API creata nel passaggio Creare un'API di test.

2. Nella finestra a destra, assicurarsi che la scheda Progettazione sia selezionata.

3. Selezionare l'operazione di test aggiunta.

4. Nella finestra Elaborazione in ingresso fare clic su + Aggiungi criteri.

   

5. Selezionare Mock responses (Simula risposte) dalla raccolta.

   

6. Nella casella di testo API Management response (Risposta di Gestione API) digitare 200 OK, application/json. Questa selezione indica che l'API deve restituire l'esempio di risposta definito nella sezione precedente.

   

7. Seleziona Salva.

   Suggerimento

   Viene visualizzata una barra gialla con il testo Simulazione abilitata. Ciò indica che le risposte restituite da Gestione API sono simulate dal criterio fittizio e non sono prodotte dal back-end.

Testare l'API fittizia

1. Selezionare l'API creata nel passaggio Creare un'API di test.

2. Selezionare la scheda Test.

3. Assicurarsi che l'API Test call sia selezionata, quindi selezionare Invia per effettuare una chiamata di test.

   

4. La risposta HTTP visualizza il codice JSON fornito come esempio nella prima sezione dell'esercitazione.

   

Passaggi successivi

Questa esercitazione ha descritto come:

• Creare un'API di test
• Aggiungere un'operazione all'API di test
• Abilitare la simulazione della risposta
• Testare l'API fittizia

Passare all'esercitazione successiva:

Trasformare e proteggere un'API pubblicata