Simulación de respuestas de APIMock API responses

Pueden importarse API de back-end en una API de APIM, o bien crearse o administrarse manualmente.Backend APIs can be imported into an APIM API or created and managed manually. Los pasos descritos en este tutorial muestran cómo usar APIM para crear una API en blanco y administrarla de forma manual.The steps in this tutorial show you how to use APIM to create a blank API and manage it manually. El tutorial muestra cómo establecer una directiva en una API para que devuelva una respuesta simulada.The tutorial shows how to set a policy on an API so it returns a mocked response. Este método permite a los desarrolladores continuar con la implementación y las pruebas de la instancia de APIM en caso de que el back-end no esté disponible para enviar respuestas reales.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 funcionalidad de simular respuestas puede resultar útil en una serie de escenarios:Ability to mock up responses can be useful in a number of scenarios:

  • Cuando la fachada de API se ha diseñado primero y la implementación de back-end se realiza más tarde.When the API façade is designed first and the backend implementation comes later. El back-end se está desarrollando en paralelo.Or, the backend is being developed in parallel.
  • Cuando el back-end no está temporalmente operativo o no se puede escalar.When the backend is temporarily not operational or not able to scale.

En este tutorial, aprenderá a:In this tutorial, you learn how to:

  • Creación de una API de pruebaCreate a test API
  • Adición de una operación a la API de pruebaAdd an operation to the test API
  • Habilitación de la simulación de respuestaEnable response mocking
  • Probar la API simuladaTest the mocked API

Respuesta de la operación simulada

Requisitos previosPrerequisites

Creación de una API de pruebaCreate a test API

Los pasos de esta sección muestran cómo crear una API en blanco sin back-end.The steps in this section show how to create a blank API with no backend. También se explica cómo agregar una operación a la API.It also shows how to add an operation to the API. Al llamar a la operación después de completar los pasos de esta sección, se produce un error.Calling the operation after completing steps in this section produces an error. No se devolverá ningún error después de finalizar los pasos descritos en la sección "Habilitación de la simulación de respuesta".You will get no errors after you complete steps in the "Enable response mocking" section.

Crear API en blanco

  1. Seleccione API en el servicio API Management.Select APIs from the API Management service.
  2. En el menú izquierdo, seleccione + Agregar API.From the left menu, select + Add API.
  3. Seleccione API en blanco en la lista.Select Blank API from the list.
  4. Escriba "API de prueba" en Nombre para mostrar.Enter "Test API" for Display name.
  5. Escriba "Sin límite" en Productos.Enter "Unlimited" for Products.
  6. Seleccione Crear.Select Create.

Adición de una operación a la API de pruebaAdd an operation to the test API

Agregar operación a la API

  1. Seleccione la API que creó en los pasos anteriores.Select the API you created in the previous step.

  2. Haga clic en + Agregar operación.Click + Add Operation.

    ConfiguraciónSetting ValorValue DESCRIPCIÓNDescription
    Nombre para mostrarDisplay name Llamada de pruebaTest call El nombre se muestra en el Portal para desarrolladores.The name that is displayed in the Developer portal.
    URL (verbo HTTP)URL (HTTP verb) GETGET Puede elegir uno de los verbos HTTP predefinidos.You can choose from one of the predefined HTTP verbs.
    URLURL /test/test Una ruta de acceso URL de la API.A URL path for the API.
    DescripciónDescription Especifique una descripción de la operación que se usa para proporcionar documentación a los desarrolladores que usen esta API en el Portal para desarrolladores.Provide a description of the operation that is used to provide documentation to the developers using this API in the Developer portal.
    Pestaña ConsultaQuery tab Puede agregar parámetros de consulta.You can add query parameters. Además de proporcionar un nombre y una descripción, puede especificar valores que se pueden asignar a este parámetro.Besides providing a name and description, you can provide values that can be assigned to this parameter. Uno de los valores se puede marcar como predeterminado (opcional).One of the values can be marked as default (optional).
    Pestaña SolicitudRequest tab Puede definir esquemas, ejemplos y tipos de contenido de solicitud.You can define request content types, examples, and schemas.
    Pestaña RespuestaResponse tab Consulte los pasos que figuran abajo de esta tabla.See steps that follow this table. Defina esquemas, ejemplos, tipos de contenido y códigos de estado de respuesta.Define response status codes, content types, examples, and schemas.
  3. Seleccione la pestaña Respuesta, que se encuentra bajo los campos URL, Nombre para mostrar y Descripción.Select the Response tab, located under the URL, Display name, and Description fields.

  4. Haga clic en + Agregar respuesta.Click + Add response.

  5. Seleccione 200 OK en la lista.Select 200 OK from the list.

  6. En el encabezado Representaciones de la derecha, seleccione + Agregar representación.Under the Representations heading on the right, select + Add representation.

  7. Escriba "application/json" en el cuadro de búsqueda y seleccione el tipo de contenido application/json.Enter "application/json" into the search box and select the application/json content type.

  8. En el cuadro de texto Ejemplo, escriba { "sampleField" : "test" }.In the Sample text box, enter { "sampleField" : "test" }.

  9. Seleccione Crear.Select Create.

Habilitación de la simulación de respuestaEnable response mocking

Habilitación de la simulación de respuesta

  1. Seleccione la API que creó en el paso "Creación de una API de prueba".Select the API you created in the "Create a test API" step.

  2. Seleccione la operación de prueba que agregó.Select the test operation that you added.

  3. En la ventana de la derecha, haga clic en Diseño.In the window on the right, click the Design tab.

  4. En la ventana Procesamiento de entrada, haga clic en + Agregar directiva.In the Inbound processing window, click + Add policy.

  5. Seleccione el icono de respuestas simuladas en la galería.Select the Mock responses tile from the gallery.

    Icono de directiva de respuestas simuladas

  6. En el cuadro de texto API Management response (Respuesta de API Management), escriba 200 OK, application/json.In the API Management response textbox, type 200 OK, application/json. Esta selección indica que la API debe devolver la respuesta de ejemplo que definió en la sección anterior.This selection indicates that your API should return the response sample you defined in the previous section.

    Habilitación de la simulación de respuesta

  7. Haga clic en Save(Guardar).Click Save.

Probar la API simuladaTest the mocked API

Probar API simulada

  1. Seleccione la API que creó en el paso "Creación de una API de prueba".Select the API you created in the "Create a test API" step.

  2. Abra la pestaña Prueba.Open the Test tab.

  3. Asegúrese de que la API de Llamada de prueba está seleccionada.Ensure the Test call API is selected.

    Sugerencia

    Una barra amarilla con el texto La simulación de respuesta está habilitada indica que las respuestas devueltas desde API Management envían una directiva de simulación y no una respuesta de back-end real.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. Seleccione Enviar para realizar una llamada de prueba.Select Send to make a test call.

  5. Respuesta HTTP muestra el JSON especificado como un ejemplo en la primera sección del tutorial.The HTTP response displays the JSON provided as a sample in the first section of the tutorial.

    Habilitación de la simulación de respuesta

VídeoVideo

Pasos siguientesNext steps

En este tutorial aprendió lo siguiente:In this tutorial, you learned how to:

  • Creación de una API de pruebaCreate a test API
  • Adición de una operación a la API de pruebaAdd an operation to the test API
  • Habilitación de la simulación de respuestaEnable response mocking
  • Probar la API simuladaTest the mocked API

Avance hasta el siguiente tutorial:Advance to the next tutorial: