Simulare le risposte di un'APIMock API responses

Le API back-end possono essere importate in un'API di Gestione API o create e gestite manualmente.Backend APIs can be imported into an APIM API or created and managed manually. I passaggi di questa esercitazione illustrano come usare Gestione API per creare un'API vuota e gestirla manualmente.The steps in this tutorial show you how to use APIM to create a blank API and manage it manually. L'esercitazione illustra come impostare un criterio per un'API in modo che restituisca una risposta fittizia.The tutorial shows how to set a policy on an API so it returns a mocked response. Questo metodo consente agli sviluppatori di procedere con l'implementazione e il test dell'istanza di Gestione API anche se il back-end non è disponibile per inviare risposte reali.This method enables developers to proceed with implementation and testing of the APIM instance even if the backend is not available to send real responses. La possibilità di simulare le risposte può essere utile in diversi scenari:Ability to mock up responses can be useful in a number of scenarios:

  • Quando la facciata dell'API viene progettata prima e l'implementazione del back-end viene eseguita in seguitoWhen the API façade is designed first and the backend implementation comes later. o quando il back-end viene sviluppato in parallelo.Or, the backend is being developed in parallel.
  • Quando il back-end è temporaneamente non operativo o non è possibile ridimensionarlo.When the backend is temporarily not operational or not able to scale.

In questa esercitazione si apprenderà come:In this tutorial, you learn how to:

  • Creare un'API di testCreate a test API
  • Aggiungere un'operazione all'API di testAdd an operation to the test API
  • Abilitare la simulazione della rispostaEnable response mocking
  • Testare l'API fittiziaTest the mocked API

Risposta di operazione fittizia

PrerequisitiPrerequisites

Creare un'API di testCreate a test API

I passaggi descritti in questa sezione illustrano come creare un'API vuota senza back-endThe steps in this section show how to create a blank API with no backend. e come aggiungere un'operazione all'API.It also shows how to add an operation to the API. La chiamata all'operazione al termine dei passaggi descritti in questa sezione genera un errore.Calling the operation after completing steps in this section produces an error. Non verranno visualizzati errori dopo avere completato i passaggi descritti nella sezione "Abilitare la simulazione della risposta".You will get no errors after you complete steps in the "Enable response mocking" section.

Creare un'API vuota

  1. Nel servizio Gestione API selezionare API.Select APIs from the API Management service.
  2. Fare clic su + Aggiungi API nel menu a sinistra.From the left menu, select + Add API.
  3. Selezionare API vuota dall'elenco.Select Blank API from the list.
  4. Immettere "Test API" in Nome visualizzato.Enter "Test API" for Display name.
  5. Immettere "Unlimited" in Prodotti.Enter "Unlimited" for Products.
  6. Selezionare Create (Crea).Select Create.

Aggiungere un'operazione all'API di testAdd an operation to the test API

Aggiungere un'operazione all'API

  1. Selezionare l'API creata nel passaggio precedente.Select the API you created in the previous step.

  2. Fare clic su + Aggiungi operazione.Click + Add Operation.

    ImpostazioneSetting ValoreValue DESCRIZIONEDescription
    Nome visualizzatoDisplay name Test callTest call Nome visualizzato nel portale per sviluppatori.The name that is displayed in the Developer portal.
    URL (verbo HTTP)URL (HTTP verb) GETGET È possibile scegliere tra uno dei verbi HTTP predefiniti.You can choose from one of the predefined HTTP verbs.
    URLURL /test/test Percorso URL per l'API.A URL path for the API.
    DescrizioneDescription Immettere una descrizione dell'operazione usata per fornire la documentazione necessaria agli sviluppatori che usano questa API nel portale per sviluppatori.Provide a description of the operation that is used to provide documentation to the developers using this API in the Developer portal.
    Scheda QueryQuery tab È possibile aggiungere parametri di query.You can add query parameters. Oltre al nome e alla descrizione, è possibile specificare i valori che possono essere assegnati a questo parametro.Besides providing a name and description, you can provide values that can be assigned to this parameter. Uno dei valori può essere contrassegnato come predefinito (facoltativo).One of the values can be marked as default (optional).
    Scheda RichiestaRequest tab È possibile definire schemi, esempi e tipi di contenuto della richiesta.You can define request content types, examples, and schemas.
    Scheda RispostaResponse tab Vedere i passaggi che seguono questa tabella.See steps that follow this table. Consente di definire schemi, esempi, tipi di contenuto e codici di stato della risposta.Define response status codes, content types, examples, and schemas.
  3. Selezionare la scheda Risposta, sotto i campi URL, Nome visualizzato e Descrizione.Select the Response tab, located under the URL, Display name, and Description fields.

  4. Fare clic su + Aggiungi risposta.Click + Add response.

  5. Selezionare 200 OK dall'elenco.Select 200 OK from the list.

  6. Sotto l'intestazione Rappresentazioni a destra selezionare + Aggiungi rappresentazione.Under the Representations heading on the right, select + Add representation.

  7. Immettere "application/json" nella casella di ricerca e selezionare il tipo di contenuto application/json.Enter "application/json" into the search box and select the application/json content type.

  8. Nella casella di testo Sample (Esempio) immettere { "sampleField" : "test" }.In the Sample text box, enter { "sampleField" : "test" }.

  9. Selezionare Create (Crea).Select Create.

Abilitare la simulazione della rispostaEnable response mocking

Abilitare la simulazione della risposta

  1. Selezionare l'API creata nel passaggio "Creare un'API di test".Select the API you created in the "Create a test API" step.

  2. Selezionare l'operazione di test aggiunta.Select the test operation that you added.

  3. Nella finestra di destra fare clic sulla scheda Progettazione.In the window on the right, click the Design tab.

  4. Nella finestra Elaborazione in ingresso fare clic su + Aggiungi criteri.In the Inbound processing window, click + Add policy.

  5. Selezionare il riquadro Mock responses (Simula risposte) dalla raccolta.Select the Mock responses tile from the gallery.

    Riquadro del criterio Mock responses (Simula risposte)

  6. Nella casella di testo API Management response (Risposta di Gestione API) digitare 200 OK, application/json.In the API Management response textbox, type 200 OK, application/json. Questa selezione indica che l'API deve restituire l'esempio di risposta definito nella sezione precedente.This selection indicates that your API should return the response sample you defined in the previous section.

    Abilitare la simulazione della risposta

  7. Fare clic su Save.Click Save.

Testare l'API fittiziaTest the mocked API

Testare l'API fittizia

  1. Selezionare l'API creata nel passaggio "Creare un'API di test".Select the API you created in the "Create a test API" step.

  2. Aprire la scheda Test.Open the Test tab.

  3. Verificare che l'API Test call sia selezionata.Ensure the Test call API is selected.

    Suggerimento

    Una barra gialla con il testo Mocking is enabled (Il comportamento fittizio è abilitato) indica che le risposte sono state restituite da Gestione API e invia un criterio fittizio e non una vera risposta back-end.A yellow bar with the text Mocking is enabled indicates that responses returned from the API Management, sends a mocking policy and not an actual backend response.

  4. Selezionare Invia per eseguire una chiamata di test.Select Send to make a test call.

  5. La risposta HTTP visualizza il codice JSON fornito come esempio nella prima sezione dell'esercitazione.The HTTP response displays the JSON provided as a sample in the first section of the tutorial.

    Abilitare la simulazione della risposta

VideoVideo

Passaggi successiviNext steps

Questa esercitazione illustra come:In this tutorial, you learned how to:

  • Creare un'API di testCreate a test API
  • Aggiungere un'operazione all'API di testAdd an operation to the test API
  • Abilitare la simulazione della rispostaEnable response mocking
  • Testare l'API fittiziaTest the mocked API

Passare all'esercitazione successiva:Advance to the next tutorial: