Tutorial: Simulación de respuestas de API
Se pueden importar API de back-end en una API de API Management (APIM), o bien se pueden crear o administrar manualmente. En los pasos de este tutorial se muestra cómo usar APIM para crear una API en blanco y administrarla manualmente. Después, 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 APIM en caso de que el back-end no esté disponible para enviar respuestas reales.
La funcionalidad de simulación de respuestas puede resultar útil en varios 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
Prerrequisitos
- Conocer la terminología de API Management de Azure.
- Comprender el concepto de directivas en API Management de Azure.
- Complete el siguiente inicio rápido: Creación de una instancia de Azure API Management.
Creación de una API de prueba
Los pasos de esta sección muestran cómo crear una API en blanco sin back-end.
Inicie sesión en Azure Portal y vaya a la instancia de API Management.
Seleccione API > + Agregar API > API en blanco.
En la ventana Crear una API en blanco, seleccione Completa.
En Nombre para mostrar, escriba API de prueba.
En Productos , seleccione Ilimitado.
Compruebe que, en Puertas de enlace, está seleccionada la opción Administrada.
Seleccione Crear.
Adición de una operación a la API de prueba
Una API expone una o varias operaciones. En esta sección, agregue una operación a la API en blanco que creó. Al llamar a la operación después de completar los pasos de esta sección, se produce un error. Dejará de recibir errores después de realizar los pasos de la sección Habilitación de la simulación de respuesta, más adelante.
Seleccione la API que creó en los pasos anteriores.
Seleccione + Agregar operación.
En la ventana Front-end, escriba los siguientes valores.
Configuración Value 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. 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.
Seleccione + Agregar respuesta y, en la lista, elija 200 - Correcto.
En el encabezado Representaciones de la derecha, seleccione + Agregar representación.
Escriba application/json en el cuadro de búsqueda y seleccione el tipo de contenido application/json.
En el cuadro de texto Ejemplo, escriba
{ "sampleField" : "test" }.Seleccione Guardar.
Aunque no es necesario en este ejemplo, se pueden configurar opciones adicionales 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. Uno de los valores se puede marcar como predeterminado (opcional). |
| Solicitud | Defina esquemas, ejemplos y tipos de contenido de solicitud. |
Habilitación de la simulación de respuesta
Seleccione la API que creó en Creación de una API de prueba.
Seleccione la operación de prueba que agregó.
En la ventana de la derecha, asegúrese de que esté seleccionada la pestaña Diseño.
En la ventana Procesamiento de entrada, seleccione + Agregar directiva.
En la galería, seleccione Mock responses (Simular respuestas).
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.
Seleccione Guardar.
Sugerencia
Una barra amarilla con el texto La simulación de respuesta está habilitada en la API indica que las respuestas devueltas por API Management son simuladas por la directiva de simulación y no las genera el back-end.
Probar la API simulada
Seleccione la API que creó en Creación de una API de prueba.
Seleccione la pestaña Prueba.
Asegúrese de que la API de Llamada de prueba está seleccionada. Seleccione Enviar para realizar una llamada de prueba.
Respuesta HTTP muestra el JSON especificado como un ejemplo en la primera sección del tutorial.
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: