Muchos desarrolladores han encontrado útil nuestro blog anterior, "Mocking an API in ONE Minute", y puede que a ti también te resulte útil. Ese blog cubría una forma rápida de simular una API, pero solo rascaba la superficie. A medida que profundicé en Apidog, descubrí características adicionales que hacen que la simulación de datos, incluso los complejos, sea más rápida.
Manejo de APIs con datos JSON complejos
Comencemos con cómo importar una API de Swagger a Apidog para simular datos JSON. De esta manera, puedes generar datos simulados sin escribir ningún script.
Sin embargo, algunos campos pueden ser difíciles de simular sin configuración adicional. Por ejemplo:
- Campos Enum con múltiples valores posibles, a menudo utilizados para campos de estado.
- Arrays de longitud fija, como una tabla donde cada fila tiene varios atributos y una página podría mostrar 20 o 50 filas.
- Objetos que referencian esquemas, como lo permite la especificación OpenAPI, donde un objeto o parte de un objeto se refiere a un esquema.
Afortunadamente, con Apidog, puedes simular estos campos JSON complejos en solo dos minutos.
¿Cómo simular APIs con datos JSON complejos rápidamente?
Aquí hay un proceso simple de tres pasos para simular APIs complejas usando Apidog:
- Importar definiciones de API.
- Personalizar las reglas de simulación de API para campos específicos.
- Obtener la URL de simulación.
Es así de fácil. Vamos a repasarlo.
Paso 1: Importar definiciones de API
Solo necesitas un archivo OpenAPI JSON o YAML. Impórtalo a Apidog y estarás listo para comenzar.
Paso 2: Personalizar las reglas de simulación de API para campos específicos
Valores Enum:
En nuestra API de muestra, el campo 'status' tiene tres opciones: available, pending y sold. Queremos que nuestros datos simulados reflejen solo uno de estos valores.
Haz clic en 'Advanced settings' en el campo 'Status', habilita el interruptor 'Enum' y agrega los valores enum. Ahora, este campo solo simulará uno de estos valores.
Arrays de longitud fija:
Para el campo de array 'PhotoUrls', necesitamos exactamente cinco elementos.
En la 'Advanced settings' del campo 'PhotoUrls', ajusta la configuración de 'Element Limit'. Establece 'minItems' y 'maxItems' en 5.
Objetos referenciados por esquema:
Apidog admite esquemas según la especificación OpenAPI. Si un objeto se refiere a un esquema, Apidog lo simulará en consecuencia. Por ejemplo, puedes referenciar el esquema para el campo 'Category'.
Paso 3: Obtener la URL de simulación de API
Haz clic en 'Save' y cambia a la pestaña 'Endpoint'. Copia la URL en la sección "Local Mock", que comienza con "127.0.0.1".
Pega la URL en tu navegador y listo.
Campos notables
Cuando revises los datos simulados, notarás:
- PhotoUrls tiene exactamente 5 elementos, todos con URLs de imagen válidas.
- Status se limita a uno de los valores enum (sold, pending o available).
- Category se refiere al esquema correcto.
Otros campos, como city y createdAt, se simulan automáticamente.
Y si actualizas la URL, los datos simulados se actualizan.
Apidog admite la simulación de esquemas JSON para APIs
Apidog es totalmente compatible con OpenAPI 3.0, que utiliza JSON Schema para definir la estructura de los datos de la API. Todos los atributos de JSON Schema son compatibles con Apidog, incluyendo:
- Rango de longitud de cadena, formato y patrón (regex)
- Valores enteros mínimo y máximo
- Configuraciones de solo lectura/solo escritura
No solo JSON, Apidog también admite la simulación de XML. Incluso puedes personalizar los nombres de las etiquetas XML y los prefijos.
Gracias a JSON Schema, puedes generar cualquier dato simulado complejo con solo unos pocos clics usando Apidog, sin necesidad de codificación.
