Módulo

En un proyecto de Apidog, puede usar módulos para organizar sus endpoints. Un módulo es similar a un "servicio" en la arquitectura técnica, diseñado para ayudarle a gestionar y presentar endpoints de forma más eficiente, especialmente en sistemas basados en microservicios. Cada módulo incluye su propio conjunto de endpoints relacionados, componentes (como esquemas, respuestas y esquemas de seguridad) y URLs base (una para cada entorno).

Cada módulo corresponde a un archivo de especificación Swagger/OpenAPI completo e independiente.

Cuándo usar módulos

Use módulos para organizar sus endpoints cuando:

Servicios estrechamente relacionados: Por ejemplo, en un proyecto de IA: un módulo para endpoints de generación de texto, otro para endpoints de generación de imágenes y uno para endpoints de voz.

Microservicios: Por ejemplo, en un proyecto de comercio electrónico, puede tener servicios de autenticación, pedidos y productos.

Varias versiones de API: Por ejemplo, su proyecto expone diferentes versiones de API a usuarios externos, como Legacy, LTS y Latest.

Crear un módulo

En el proyecto, pase el cursor sobre la parte superior del árbol de carpetas y haga clic en el botón +. En el menú desplegable, seleccione Nuevo módulo.

Introduzca el nombre del módulo y haga clic en Guardar. El nuevo módulo aparecerá en el árbol de carpetas. Haga clic en el módulo para ver sus detalles, incluidos:

Estadísticas de datos de los recursos del módulo

Cobertura de casos de endpoint y escenarios de prueba

Opciones de exportación para endpoints del módulo

Configuración de la fuente de datos

Variables del módulo: similares a las variables de entorno, pero solo accesibles dentro de las peticiones de endpoints de este módulo.

Configurar la URL base para cada módulo

Una vez creado un módulo, aparecerá automáticamente en la página de Gestión de entornos. Puede asignar una URL base para cada entorno dentro del módulo recién añadido.

Configurar la URL base del módulo en la gestión de entornos

Usar la URL base correcta al realizar peticiones

De forma predeterminada, las peticiones de endpoints de cada módulo usarán automáticamente la URL base definida para ese módulo en el entorno actual, combinada con la ruta del endpoint. Los endpoints de un módulo no pueden usar la URL base de otro módulo para enviar peticiones.

Uso automático de la URL base en peticiones

Patrón de uso heredado

Si un solo módulo contiene varios servicios (varias URLs base), puede especificar manualmente qué URL base usar a nivel de carpeta o de endpoint dentro del módulo.

Sin embargo, este enfoque formaba parte de un patrón de uso anterior en Apidog y no se recomienda desde la versión 2.7.16. En su lugar, sugerimos dividir los servicios en módulos separados, cada uno con su propia URL base.

Más información: Entornos y servicios

Cuándo usar módulos#

Crear un módulo#

Configurar la URL base para cada módulo#

Usar la URL base correcta al realizar peticiones#

Cuándo usar módulos

Crear un módulo

Configurar la URL base para cada módulo

Usar la URL base correcta al realizar peticiones