Al realizar peticiones de API, a menudo es necesario cambiar entre entornos de desarrollo, prueba y producción. Apidog facilita el envío de peticiones a diferentes entornos: solo necesita hacer clic y seleccionar el entorno deseado en la esquina superior derecha de la interfaz.Un entorno de Apidog consta de dos elementos principales:1.
URL base: Mantiene el destino de entrega de la petición.
2.
Variables: Grupos de variables que pueden referenciarse en peticiones o scripts.
Al cambiar entre entornos, tanto la URL base como las variables de entorno utilizarán los valores definidos en el entorno actual.Crear un entorno#
1
Abrir Gestión de entornosHaga clic en el botón Gestión de entornos ≡ en la esquina superior derecha de la interfaz.
2
Crear nuevo entornoHaga clic en el último elemento de la lista del lado izquierdo etiquetado como Nuevo entorno.
3
Configurar entornoIntroduzca un nombre para su nuevo entorno. Añada la URL base y las variables. 5
Seleccionar entornoPara utilizar el nuevo entorno, selecciónelo desde el selector de entorno en la parte superior derecha de la interfaz. Esto lo convierte en el entorno activo y establece todas las variables con los valores especificados en el entorno.
Apidog mantiene una separación clara entre los entornos y las URL base. Los entornos representan diferentes etapas de despliegue (desarrollo, prueba, producción), mientras que las URL base se configuran dentro de cada entorno. Esta separación proporciona flexibilidad al gestionar múltiples servicios o microservicios en diferentes entornos.En cambio, los entornos de Apidog reflejan directamente entornos reales como desarrollo, prueba y producción, en lugar de tratar cada URL base como un único entorno.
URL base#
La URL base es la función principal en un entorno de Apidog. En Apidog, una ruta de endpoint normalmente comienza con una barra diagonal (/) y no incluye la URL base. Al enviar una petición, Apidog antepone la URL base de destino a la ruta del endpoint.Un formato estandarizado de URL base comienza con el protocolo y excluye la barra diagonal final (/).Cada URL base corresponde a un Módulo específico. En la mayoría de los casos, un endpoint utilizará la URL base de su módulo para enviar peticiones.Por ejemplo, si la URL base del módulo predeterminado para el entorno de Producción es http://abc.com/v1 y la ruta de su endpoint es /pet, entonces, cuando envíe una petición en el entorno de Producción, la URL real de la petición enviada sería:Si la ruta del endpoint comienza con http:// o https://, la URL base no se anexará. Sin embargo, generalmente no se recomienda codificar URL completas de forma rígida en los endpoints.
En Apidog, existe una variable de entorno especial llamada BASE_URL que almacena la URL base del "Default Server" del entorno actual. Generalmente no se recomienda utilizar esta variable directamente.Para scripts personalizados:Recomendado: Use pm.request.getBaseUrl() para obtener la URL base del endpoint actual.
Evite: Usar pm.environment.get('BASE_URL'), ya que puede no capturar correctamente la URL base si el endpoint no ocupa el "Default Server".
Si crea manualmente una variable de entorno etiquetada como BASE_URL, esta tendrá prioridad sobre la BASE_URL predefinida del sistema.Nota: Los scripts no pueden modificar la configuración de la URL base en sí. El comando pm.environment.set('BASE_URL', 'My_url') solo creará una variable llamada BASE_URL. Usar múltiples URL base con módulos#
Si los endpoints de su proyecto necesitan conectarse a múltiples URL base (por ejemplo, microservicios), la mejor manera de gestionarlos es usando múltiples Módulos en Apidog.Endpoints de usuario: https://user.example.com
Endpoints de pedidos: https://order.example.com
Endpoints de productos: https://product.example.com
1
Crear módulosEn la parte superior del árbol de carpetas de API, añada múltiples módulos correspondientes a sus servicios. 2
Configurar URL baseEn Gestión de entornos, verá campos para establecer la URL base de cada módulo. Introduzca las URL para cada entorno y haga clic en Guardar. 3
Establecer la URL base del móduloEn la configuración de la carpeta raíz de un módulo, elija qué URL base deben usar los endpoints del módulo.Configuración predeterminada: Usa la primera URL base listada para ese módulo (recomendado).
Especificar manualmente: Seleccione otra URL base manualmente. (No recomendado para la mayoría de los casos).
4
HerenciaEn subcarpetas o endpoints individuales, también puede especificar la URL base.Heredar de los elementos superiores: Sigue la carpeta principal (predeterminado).
Especificar manualmente: Sobrescriba para elementos específicos.
5
Enviar peticionesUna vez configurado, simplemente haga clic en Enviar. Apidog determina la URL base adecuada según la configuración del módulo y del entorno.
Añadir variables de entorno#
Cuando añade una variable a un entorno, puede especificar dos valores:Valor inicial: Compartido con el equipo.
Valor actual: Almacenado localmente en su equipo.
Cambiar entre entornos#
Apidog muestra el entorno actual en el selector de entorno en la parte superior derecha del área de trabajo. Cada vez que realice una petición o ejecute un script, Apidog utilizará los valores actuales de todas las variables en el entorno seleccionado.Para cambiar, simplemente elija un entorno diferente desde el selector.Endpoints frente a peticionesEndpoint: La especificación de la API (la ruta normalmente comienza con /).
Petición: La petición HTTP real enviada (incluye la URL completa).
Los servicios definidos en un entorno se aplican a los endpoints. Al usar la pestaña Petición para depuración ad hoc (similar a Postman), puede usar la sintaxis {{Base_url}} si es necesario. Migración de entornos#
En Apidog, el Valor inicial de las variables se sincroniza dentro del equipo, mientras que el Valor actual solo se almacena localmente. Esto significa que los valores actuales no se trasladan a otros dispositivos.Apidog proporciona funcionalidad de exportación/importación para migrar entornos (incluidos los valores actuales locales) entre equipos.1
ExportarEn Gestión de entornos, sitúe el cursor sobre ... junto al entorno y haga clic en Exportar para obtener un archivo JSON. 2
ImportarEn el equipo de destino, abra Gestión de entornos, sitúe el cursor sobre ..., haga clic en Importar y seleccione el archivo JSON.
Alcance de visibilidad de los entornos#
Puede crear Entornos privados para las variables que no desea compartir.En la esquina superior derecha de la configuración del entorno, establezca el alcance de visibilidad.Compartido: Visible para el equipo (predeterminado).
Privado: Visible solo para usted.
Los entornos privados comparten la misma lista de servicios (URL base) que otros entornos. Añadir o eliminar servicios en un entorno privado afectará simultáneamente a todos los entornos.
Preguntas frecuentes#
¿Cómo obtener la URL base del servicio en un script personalizado?Use pm.request.getBaseUrl() para recuperar la URL base del endpoint actual.