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 di Azure o create e gestite manualmente. I passaggi di questa esercitazione descrivono 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 continuare con l'implementazione e il test dell'istanza di Gestione API anche se il back-end non è disponibile per inviare risposte reali.

Suggerimento

I team API possono usare questa funzionalità nelle aree di lavoro. Le aree di lavoro forniscono accesso amministrativo isolato alle API e ai propri ambienti di runtime API.

La possibilità di creare risposte fittizie è utile in molti scenari:

• Quando la facciata DELL'API è progettata per prima e l'implementazione back-end viene eseguita in un secondo momento o quando il back-end viene sviluppato in parallelo.
• Quando il backend non è temporaneamente operativo o non è in grado di scalare.

In questa esercitazione verranno illustrate le procedure per:

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

Prerequisiti

• Informazioni sulla terminologia di Gestione API.
• Comprendere il concetto di criteri in Gestione API.
• Completare la procedura rapida 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. In Nome visualizzato immettere Test API.

5. In Prodotti selezionare Illimitato, se tale valore è disponibile. Questo valore è disponibile solo in alcuni livelli. È possibile lasciare vuoto il valore per questa esercitazione, ma è necessario associare l'API a un prodotto per pubblicarlo. Per altre informazioni, vedere Importare e pubblicare la prima API.

6. In Gateway selezionare Gestito se questa opzione è disponibile. Questa opzione è disponibile solo in determinati livelli di servizio.

7. Selezionare Crea.

   

Aggiungere un'operazione all'API di test

Un'API espone una o più operazioni. In questa sezione si aggiunge 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 nella sezione Abilitare la simulazione della risposta , non verrà visualizzato un errore.

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 (prima casella)	GET	Selezionare uno dei verbi HTTP predefiniti.
   URL (seconda casella)	/test	Percorso URL per l'API.
   Descrizione		Descrizione facoltativa dell'operazione. Fornisce la documentazione nel portale per sviluppatori agli sviluppatori che usano l'API.

   

4. Selezionare la scheda Risposte , che si trova nelle caselle URL, Nome visualizzato e Descrizione . In questa scheda verranno immessi valori per definire codici di stato della risposta, tipi di contenuto, esempi e schemi.

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

   

6. Nella sezione Rappresentazioni selezionare + Aggiungi rappresentazione.

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

8. Nella casella Esempio immettere { "sampleField" : "test" }.

9. Selezionare Salva.

   

Anche se non è necessario per questo esempio, è possibile configurare altre impostazioni per un'operazione API in altre schede, come descritto nella tabella seguente:

Scheda	Descrizione
Quesito	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).
Richiesta	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:

• Utilizzare l'ambiente Bash in Azure Cloud Shell. Per altre informazioni, vedere Introduzione ad 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, considerare l'esecuzione dell'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 Eseguire l'autenticazione ad Azure con 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 e gestire 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 <resource-group> \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name <API-management-service-name> 

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

az apim api operation list --resource-group <resource-group-name> \
    --api-id test-api --service-name <API-management-service-name> --output table

Mantenere questa operazione pronta per l'uso per il resto dell'articolo. Se si vuole rimuovere un'operazione, è possibile usare il comando az apim api operation delete . Ottenere l'ID operazione dal passaggio precedente.

az apim api operation delete --resource-group <resource-group-name> \
    --api-id test-api --operation-id <ID> \
    --service-name <API-management-service-name>

Abilitare la simulazione della risposta

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

2. Verificare che la scheda Progettazione sia selezionata.

3. Selezionare l'operazione di test aggiunta.

4. Nella sezione Elaborazione in ingresso selezionare Aggiungi criteri.

   

5. Selezionare il riquadro Simula riposte dalla raccolta:

   

6. Assicurarsi che 200 OK, application/json venga visualizzato nella casella di risposta di Gestione API . Questa selezione indica che l'API deve restituire l'esempio di risposta definito nella sezione precedente.

   

7. Selezionare Salva.

   Suggerimento

   Viene visualizzata una barra gialla che mostra il testo La simulazione è attivata. Questo messaggio indica che le risposte restituite da Gestione API sono simulate dai criteri di simulazione e non sono prodotte dal back-end.

Testare l'API fittizia

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

2. Nella scheda Test verificare che l'API Test call sia selezionata e quindi selezionare Invia per effettuare una chiamata di test:

   

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

   

Passo successivo

Passare all'esercitazione successiva:

Trasformare e proteggere un'API pubblicata