Compartir a través de


Tutorial: Simulación de respuestas de API

SE APLICA A: todos los niveles de API Management

Las API de back-end se importan en una API de API Management (APIM), o bien se crean o administran manualmente. En los pasos de este tutorial se muestra cómo:

  • Usar API Management para crear una API HTTP en blanco
  • Administrar una API HTTP de forma manual
  • Establecer una directiva en una API para que devuelva una respuesta simulada

Este método permite a los desarrolladores continuar con la implementación y las pruebas de la instancia de API Management incluso si el back-end no está disponible para enviar respuestas reales.

La capacidad de simular respuestas es útil en muchos escenarios:

  • Cuando la fachada de API se ha diseñado primero y la implementación de back-end se realiza más tarde. El back-end se está desarrollando en paralelo.
  • Cuando el back-end no está temporalmente operativo o no se puede escalar.

En este tutorial, aprenderá a:

  • Creación de una API de prueba
  • Adición de una operación a la API de prueba
  • Habilitación de la simulación de respuesta
  • Probar la API simulada

Respuesta de API simulada

Requisitos previos

Creación de una API de prueba

En los pasos de esta sección se muestra cómo crear una API HTTP sin back-end.

  1. Inicie sesión en Azure Portal y, después, vaya a la instancia de API Management.

  2. Seleccione el icono API>+ Agregar API>HTTP.

    Definición de una API HTTP

  3. En la ventana Crear una API HTTP, seleccione Completa.

  4. En Nombre para mostrar, escriba API de prueba.

  5. En Productos , seleccione Ilimitado.

  6. Asegúrese de que Administrado está seleccionado en Puertas de enlace.

  7. Seleccione Crear.

    Creación de una API HTTP

Adición de una operación a la API de prueba

Una API expone una o varias operaciones. En esta sección, agregará una operación a la API HTTP que ha creado. Al llamar a la operación después de completar los pasos de esta sección, se desencadena un error. Después de finalizar los pasos descritos en la sección Habilitación de la simulación de respuesta no se devolverá ningún error.

  1. Seleccione la API que creó en los pasos anteriores.

  2. Seleccione + Agregar operación.

  3. En la ventana Front-end, escriba los siguientes valores.

    Ventana de frontend

    Configuración valor Descripción
    Nombre para mostrar Llamada de prueba El nombre se muestra en el portal para desarrolladores.
    URL (verbo HTTP) GET Seleccione uno de los verbos HTTP predefinidos.
    URL /test Una ruta de acceso URL de la API.
    Descripción Descripción opcional de la operación que se usa para proporcionar documentación en el portal para desarrolladores a aquellos que usan esta API.
  4. Seleccione la pestaña Respuestas, que se encuentra bajo los campos URL, Nombre para mostrar y Descripción. Especifique la configuración de esta pestaña para definir códigos de estado de respuesta, tipos de contenido, ejemplos y esquemas.

  5. Seleccione + Agregar respuesta y, en la lista, elija 200 - Correcto.

    Adición de una respuesta a la operación de la API

  6. En el encabezado Representaciones de la derecha, seleccione + Agregar representación.

  7. Escriba application/json en el cuadro de búsqueda y seleccione el tipo de contenido application/json.

  8. En el cuadro de texto Ejemplo, escriba { "sampleField" : "test" }.

  9. Seleccione Guardar.

    Adición de representación a la operación de la API

Aunque no es necesario en este ejemplo, puede configurar más valores para una operación de API en otras pestañas, por ejemplo:

Pestaña Descripción
Consultar Agregue parámetros de consulta. Además de proporcionar un nombre y una descripción, puede especificar valores que se asignan a un parámetro de consulta. Puede marcar uno de los valores como predeterminado (opcional).
Solicitud Defina esquemas, ejemplos y tipos de contenido de solicitud.

Habilitación de la simulación de respuesta

  1. Seleccione la API que creó en Creación de una API de prueba.

  2. En la ventana de la derecha, asegúrese de que esté seleccionada la pestaña Diseño.

  3. Seleccione la operación de prueba que agregó.

  4. En la ventana Procesamiento de entrada, seleccione + Agregar directiva.

    Adición de directiva de procesamiento

  5. En la galería, seleccione Mock responses (Simular respuestas).

    Icono de directiva de respuestas simuladas

  6. En el cuadro de texto API Management response (Respuesta de API Management), escriba 200 OK, application/json. Esta selección indica que la API debe devolver la respuesta de ejemplo que definió en la sección anterior.

    Establecimiento de respuestas simuladas

  7. Seleccione Guardar.

    Sugerencia

    Se muestra una barra amarilla con el texto Simulación habilitada. Esto indica que las respuestas devueltas desde API Management se simulan mediante la directiva de simulación y no las genera el back-end.

Probar la API simulada

  1. Seleccione la API que creó en Creación de una API de prueba.

  2. Seleccione la pestaña Prueba.

  3. Asegúrese de que la API Llamada de Prueba está seleccionada y, después, seleccione Enviar para realizar una llamada de prueba.

    Probar la API simulada

  4. Respuesta HTTP muestra el JSON especificado como un ejemplo en la primera sección del tutorial.

    Simulación de respuestas HTTP

Pasos siguientes

En este tutorial, ha aprendido a:

  • Creación de una API de prueba
  • Adición de una operación a la API de prueba
  • Habilitación de la simulación de respuesta
  • Probar la API simulada

Avance hasta el siguiente tutorial: