Una URL base en Apidog le permite extraer la parte repetida de las direcciones de sus endpoints para una gestión unificada.
Por ejemplo, si su endpoint es https://api.example.com/v1/users, puede establecer https://api.example.com/v1 como la URL base. Entonces, en la definición de su endpoint, solo necesitará escribir /users.
Al enviar una solicitud, Apidog concatenará automáticamente la URL base y la ruta del endpoint para formar la dirección de solicitud completa. El beneficio es que si la dirección del servidor cambia, solo necesita actualizar la URL base, sin necesidad de modificar cada endpoint individualmente.
Pasos para configurar una URL base
Abra su proyecto Apidog y busque "Gestión de Entornos" en la esquina superior derecha. Apidog creará varios entornos comunes por defecto, como desarrollo, pruebas y producción. Puede usar estos preajustes o crear nuevos entornos según sea necesario.
Después de seleccionar un entorno, verá el cuadro de entrada "URL base". Ingrese la dirección base comenzando con el protocolo (http:// o https://), como https://test.server.com, o incluya un número de versión como https://api.example.com/v1.
Asegúrese de no añadir una barra inclinada al final. Según la especificación OpenAPI, la URL base no debe terminar con un /, mientras que la ruta del endpoint debe comenzar con un /.
Recomendamos seguir la especificación OpenAPI para una mejor compatibilidad y una experiencia de funciones más completa en Apidog.
Uso de la URL base en los endpoints
Ahora, cuando cree un nuevo endpoint, solo necesita ingresar la ruta del endpoint en el campo URL. Por ejemplo, para probar el endpoint de la lista de usuarios, simplemente ingrese /users, y Apidog lo combinará automáticamente en la URL de solicitud completa https://api.example.com/v1/users.
Si la ruta de su endpoint incluye varios niveles, como /users/123/profile, puede seguir el mismo método: Apidog combinará automáticamente la URL base con su ruta para formar la URL de solicitud completa.
Nota: Si ingresa una dirección completa (que comienza con http:// o https://) en la URL del endpoint, la URL base no se utilizará. Apidog priorizará la dirección completa que usted proporcione.
Gestión de URLs base en múltiples entornos
La mayoría de los proyectos tienen múltiples entornos (desarrollo, pruebas, producción), cada uno con una dirección de servidor diferente. Puede establecer una URL base diferente para cada entorno.
Por ejemplo:
- Desarrollo:
https://dev-api.example.com/v1 - Pruebas:
https://test-api.example.com/v1 - Producción:
https://api.example.com/v1
Cuando cambie de entorno desde la esquina superior derecha, todos los endpoints utilizarán automáticamente la dirección del servidor para el entorno seleccionado.
También puede elegir el entorno directamente en la barra de direcciones del endpoint, donde se muestra la URL base predeterminada para cada entorno. Esto funciona de la misma manera que cambiar de entorno en el panel de "Gestión de Entornos".
Nota: Si un entorno tiene varias URLs base, solo aparecerá la predeterminada en la barra de direcciones. Para usar una URL base no predeterminada para endpoints específicos, deberá configurarla manualmente dentro del endpoint o gestionarla a través de módulos.
Esta configuración de múltiples URLs base es común en arquitecturas de microservicios, donde diferentes endpoints necesitan usar diferentes direcciones de servicio.
Gestión de URLs base en microservicios
Si su proyecto utiliza una arquitectura de microservicios y no todos los endpoints comparten la misma URL base, tiene dos formas de gestionar las URLs base en Apidog.
Especificar manualmente URLs base dentro de un módulo
Puede agrupar endpoints de diferentes servicios en un solo módulo y asignar diferentes URLs base a carpetas específicas o a endpoints individuales. Esta configuración es flexible y funciona bien para equipos que prefieren una gestión centralizada.
Por ejemplo, puede configurar un módulo con múltiples URLs base para diferentes servicios.
Luego, asigne la URL base de "Servicio de Usuario" a la carpeta de usuario y la URL base de "Servicio de Pedido" a la carpeta de pedido. Todos los endpoints dentro de cada carpeta utilizarán automáticamente la URL base correspondiente.
Si no desea configurar por carpeta, también puede establecer la URL base para endpoints individuales. Simplemente abra la página "Editar" del endpoint y seleccione la URL base deseada en el menú desplegable.
Sin embargo, a medida que crece el número de servicios, la gestión de URLs base de esta manera puede volverse tediosa y más difícil de mantener. Puede funcionar bien para proyectos más pequeños, pero los proyectos más grandes pueden volverse rápidamente difíciles de gestionar.
Para una mejor escalabilidad y claridad, recomendamos un enfoque más estructurado:
separe cada servicio en su propio módulo y establezca la URL base a nivel de módulo. Esto mantiene su proyecto organizado y mucho más fácil de mantener.
Organizar servicios por módulo (Recomendado)
Cree un módulo separado para cada servicio y configure su URL base en "Gestión de Entornos" para cada entorno. Este enfoque es más organizado e ideal para la colaboración en equipo y el mantenimiento a largo plazo.
Por ejemplo, puede crear módulos separados para el Servicio de Usuario, el Servicio de Pedido y el Servicio de Producto, cada uno vinculado a su propio archivo de especificación Swagger u OpenAPI.
Una vez configurados los módulos, vaya a la página de "Gestión de Entornos", donde verá la configuración de la URL base agrupada ordenadamente por módulo.
Cada entorno comparte la misma estructura de módulo, pero la URL base para cada módulo puede variar según el entorno. Esto le permite asignar URLs base específicas para cada módulo en cada entorno. Por ejemplo:
| Entorno | Servicio de Producto | Servicio de Usuario | Servicio de Pedido |
|---|---|---|---|
| Producción | https://product.example.com | https://user.example.com | https://order.example.com |
| Pruebas | http://192.168.1.10:8080 | http://192.168.1.11:8080 | http://192.168.1.12:8080 |
| Desarrollo | http://localhost:3000 | http://localhost:3001 | http://localhost:3002 |
Con esta configuración, cada vez que cree un nuevo endpoint dentro de un módulo, este utilizará automáticamente la URL base correcta para el entorno actual, sin necesidad de seleccionarla manualmente. Por ejemplo:
- En el "Módulo de Servicio de Usuario y Entorno de Producción", la URL base predeterminada es
https://user.example.com. - En el "Módulo de Servicio de Pedido y Entorno de Pruebas", es
http://192.168.1.12:8080.
Piense en la combinación "Módulo + Entorno" como un sistema de coordenadas que determina con precisión la URL de la solicitud. Siempre que sus módulos y entornos estén correctamente organizados, Apidog elegirá automáticamente la URL base correcta para cada solicitud.
Ya no tendrá que preguntarse: "¿Qué dirección está usando este endpoint?", simplemente seleccione el módulo y el entorno apropiados, y Apidog se encargará del resto.Preguntar a ChatGPT
Consejos prácticos para usar URLs base
- Si su API incluye un número de versión, agréguelo directamente a la URL base, por ejemplo:
https://api.example.com/v2. De esta manera, cuando actualice la versión de la API, solo necesitará actualizar la URL base, no cada endpoint. - Para casos especiales, como llamar a servicios de terceros, puede ingresar la URL completa directamente en el endpoint. Esto anulará automáticamente la URL base predeterminada.
Conclusión
Gestionar eficazmente las URLs base es clave para mantener sus proyectos API limpios, escalables y fáciles de mantener, especialmente a medida que aumentan en complejidad. Ya sea que trabaje con un proyecto simple de un solo servicio o una gran arquitectura de microservicios, Apidog ofrece opciones flexibles que se adaptan a su flujo de trabajo.
Al organizar sus servicios en módulos y configurar las URLs base por entorno, se asegura de que cada endpoint siempre apunte al servidor correcto, sin sobrecarga manual. Con valores predeterminados inteligentes, cambio de entorno y diseño modular, Apidog simplifica el proceso y elimina las conjeturas.