Puede configurar los detalles de conexión a la base de datos en la configuración del proyecto. Una vez configuradas, puede utilizar estas conexiones durante la depuración y las pruebas de endpoints agregando operaciones de base de datos en los pasos de pre/postprocesadores. Esto le permite leer de la base de datos o escribir en ella sin inconvenientes.La versión gratuita de Apidog admite la conexión a las siguientes bases de datos:SQL Server: admite SQL Server 2014 y versiones posteriores
Oracle (conectarse a una base de datos Oracle requiere instalar Oracle Client) ClickHouse (requiere el plan Basic)
MongoDB (requiere el plan Basic)
Redis (requiere el plan Basic)
Configurar la conexión a la base de datos#
Siga estos pasos para configurar una conexión a la base de datos en Apidog:1.
Abra Configuración del proyecto → Conexiones de base de datos.
2.
Haga clic en + Nuevo en la esquina superior derecha para crear una conexión a la base de datos.
3.
Seleccione el tipo de base de datos entre las opciones disponibles y complete la información de conexión necesaria, como host, puerto, nombre de la base de datos, nombre de usuario y contraseña. Se recomienda usar variables para completarla. Las conexiones a bases de datos completadas íntegramente con variables pueden guardarse en la nube para colaboración.
4.
Además del método de conexión local mediante nombre de usuario y contraseña, también puede establecer una conexión más segura a través de un túnel SSH para proteger mejor la transmisión de datos.
5.
Haga clic en Guardar, y esta conexión podrá utilizarse en los pre/postprocesadores.
Usar la conexión a la base de datos#
Puede agregar "Operaciones de base de datos" en los pre/postprocesadores de una petición de endpoint para hacer referencia a una conexión a la base de datos. Después de agregarla, puede especificar una conexión a la base de datos en "Operaciones de base de datos".A continuación se indican los pasos específicos para las operaciones de base de datos:1.
En la pestaña Ejecutar (Modo de diseño) o en la pestaña Petición (Modo de petición), vaya a los pre/postprocesadores.
2.
Pase el cursor sobre Agregar preprocesador o Agregar postprocesador y seleccione Operación de base de datos.
3.
Asigne un nombre a la operación de base de datos y configure la conexión a la base de datos. Asegúrese de que la "Conexión a la base de datos" seleccionada esté configurada correctamente. Más información. 4.
Introduzca el comando SQL. Se admiten variables como {{variables}} en los comandos.
5.
Habilite Extraer resultado a variable (admite JSONPath) y active Registro de consola si es necesario.
6.
Haga clic en Enviar para ejecutar la petición del endpoint y revise el resultado en la consola.
Apidog admite consultas SQL estándar, pero no admite operaciones SQL complejas, como procedimientos almacenados.
Notas importantes#
Antes de ejecutar operaciones de base de datos mediante peticiones, asegúrese de que la conexión a la base de datos configurada esté guardada correctamente:Si su conexión a la base de datos usa variables y está almacenada en la nube, asegúrese de establecer los detalles reales de la base de datos (como host, nombre de usuario, contraseña, etc.) en el campo Valor actual de las variables relacionadas. Como alternativa, puede usar el método de establecer variable para configurar estos valores dinámicamente.
Si la conexión a la base de datos usa texto fijo y está almacenada localmente, debe introducir los detalles reales de la base de datos (como host, nombre de usuario, contraseña, etc.) en Configuración del proyecto → Conexión a la base de datos.
Mecanismo de almacenamiento y seguridad de los datos#
Actualmente, Apidog ofrece dos formas de almacenar conexiones a bases de datos:Almacenado en Apidog Cloud: si la conexión a la base de datos se configura íntegramente mediante variables, se almacenará como variables en el servidor en la nube de Apidog.
Almacenado localmente: si la conexión a la base de datos se configura mediante texto fijo, se almacenará como texto sin formato en el archivo de configuración local.
Diferencias entre los mecanismos de almacenamiento#
| Mecanismo de almacenamiento | Método de almacenamiento | Ventajas | Desventajas |
|---|
| Nube | Usar variables en la configuración | 1. Permite una colaboración más cómoda con los miembros del equipo.
2. Al ejecutar escenarios de prueba mediante CI, Runner, etc., puede usar variables para establecer los detalles de conexión a la base de datos en lugar de mantener archivos locales. | ⚠️ Cuando se usa texto sin formato en los valores iniciales de las variables, datos como nombres de bases de datos y contraseñas se transmitirán en texto sin formato a los servidores en la nube de Apidog, lo que supone un riesgo para la seguridad de los datos (usar valores actuales para las variables mantiene los datos almacenados localmente, lo que elimina este riesgo). Se recomienda usar variables de bóveda para evitar riesgos de seguridad de los datos. |
| Local | Usar texto fijo en la configuración | Almacenado localmente sin riesgo de seguridad | 1. Colaboración deficiente; cada miembro del equipo debe configurar la conexión a la base de datos individualmente.
2. Al ejecutar escenarios de prueba mediante CI, Runner o herramientas similares, debe mantener un archivo local dedicado para las conexiones a bases de datos. |
Para equilibrar una excelente experiencia de usuario con la seguridad de los datos, Apidog recomienda guardar las conexiones a bases de datos en la nube y usar variables de Vault para garantizar la seguridad de los datos. Se desaconseja encarecidamente usar texto sin formato en los valores iniciales de las variables relacionadas con conexiones a bases de datos, ya que esto puede ocasionar riesgos significativos de seguridad de los datos.
