Generar esquemas a partir de JSON, etc.

Al crear un esquema, Apidog ofrece una herramienta muy útil que le permite identificar y crear rápidamente un esquema a partir de datos existentes. Al hacer clic en Generate from JSON etc., accederá a la herramienta de importación de estructuras de datos.

Aquí, puede pegar su JSON, XML, JSON Schema e Import from Database, y Apidog generará automáticamente un esquema basado en esos datos.

Generar a partir de JSON/XML

Para JSON/XML, solo necesita pegar el JSON o XML existente en el área designada, y se reconocerá y convertirá automáticamente en el esquema y los tipos de datos correspondientes.

Notas importantes

El reconocimiento inteligente de JSON sirve para generar estructuras de datos basadas en el JSON proporcionado, sin guardar los valores contenidos en el propio JSON.

Todas las propiedades que aparezcan en JSON/XML se tratarán como required.

Los campos como la descripción y el mock se dejarán en blanco.

Modo de sobrescritura

Cuando un esquema se genera a partir de JSON por segunda vez, los datos recién importados sobrescribirán el esquema existente que ya se había generado. En este escenario, hay dos modos de sobrescritura:

Merge (Default): Cuando se encuentre una clave coincidente, se conservarán el mock y la descripción del esquema original.

Overwrite: Todos los datos existentes se descartarán, y los nuevos datos reemplazarán por completo a los datos anteriores.

Estilo de nomenclatura

Puede elegir el estilo de nomenclatura adecuado:

Keep it as is

camelCase

PascalCase

snake_case

Guardar como ejemplo

Al usar Generate from JSON en el cuerpo de la petición o en la respuesta, habilitar Save as Example incluirá el JSON/XML actual como un ejemplo de petición/respuesta al generar el esquema.

Generar a partir de JSON Schema

Simplemente pegar un JSON Schema permite el reconocimiento visual de la estructura de datos.

Importar desde una base de datos

Apidog admite dos métodos para generar esquemas a partir de tablas de base de datos. El primer método consiste en conectarse directamente a la base de datos para leer las estructuras de las tablas, mientras que el segundo método implica pegar SQL DDL para reconocer la estructura de la tabla.

Conexiones de base de datos

Para importar esquemas desde bases de datos, siga estos pasos:

Configure la conexión de base de datos. Obtenga más información sobre Manage Database Connection.

Bases de datos compatibles

Apidog Free admite bases de datos MySQL, SQL Server, Oracle y PostgreSQL, mientras que la versión de pago también incluye compatibilidad con ClickHouse, MongoDB y Redis.

Seleccione la conexión de base de datos en Import from database.

Seleccione las tablas que desea importar.

Configure las opciones de importación. Para ajustes de configuración específicos, consulte las secciones anteriores sobre el manejo de JSON/XML.

Configuración de longitud de campos

Cuando el conmutador Follow database field length está habilitado, Apidog establecerá los valores mínimos y máximos de longitud de propiedad en función de las longitudes de campo definidas en la tabla.

Introducir SQL (DDL)

Pegue la sentencia CREATE de la tabla de base de datos (DDL) para generar el esquema. Se admite SQL compatible con MySQL.

Para ajustes de configuración específicos, consulte las secciones anteriores sobre el manejo de JSON/XML.

Generar esquemas a partir de JSON, etc.

Generar a partir de JSON/XML#

Modo de sobrescritura#

Estilo de nomenclatura#

Guardar como ejemplo#

Generar a partir de JSON Schema#

Importar desde una base de datos#

Conexiones de base de datos#

Introducir SQL (DDL)#

Generar a partir de JSON/XML

Modo de sobrescritura

Estilo de nomenclatura

Guardar como ejemplo

Generar a partir de JSON Schema

Importar desde una base de datos

Conexiones de base de datos

Introducir SQL (DDL)