Importación programada sincroniza automáticamente sus especificaciones de API desde fuentes externas hacia Apidog a intervalos regulares. Esta función es ideal para equipos que mantienen sus especificaciones de API en sistemas externos (como repositorios Git o endpoints Swagger), pero desean aprovechar las potentes capacidades de depuración y pruebas de Apidog sin reimportaciones manuales.Con la Importación programada, usted puede:Mantener una única fuente de verdad para sus especificaciones de API en su sistema de control de versiones preferido
Sincronizar cambios automáticamente a intervalos personalizables (cada 30 minutos, cada hora, diariamente, etc.)
Importar desde múltiples fuentes, incluidas GitHub, GitLab, Azure DevOps y URL directas
Mantener a su equipo alineado con los cambios más recientes de la API sin intervención manual
Cómo configurar#
1
Vaya a ConfiguraciónVaya a Settings -> Import Data -> Scheduled Import (Bind Data Sources).
2
Cree una fuente de datosHaga clic en "New" para agregar una configuración.
3
Configure los ajustesComplete los detalles de la fuente de datos (URL, frecuencia, etc.). Vaya a la siguiente sección para obtener detalles sobre cómo vincular un repositorio Git.
4
Guarde y activeHaga clic en Save. La importación ahora se ejecutará automáticamente según sus ajustes de frecuencia.
Apidog admite la creación de múltiples fuentes de datos dentro de un único proyecto, cada una sincronizando e importando en carpetas diferentes.
Vincular un repositorio Git#
Apidog admite la vinculación de repositorios Git desde:Para vincular un repositorio Git, siga estos pasos.1
Seleccione la opción
Git Repository en el cuadro de diálogo
Bind Data Sources y cree una conexión de repositorio.
2
Después de seleccionar su plataforma de control de versiones preferida, siga las instrucciones para otorgar a Apidog acceso a sus repositorios.
3
Cuando se le redirija de nuevo a Apidog, seleccione su
Organization y
Repository, y luego haga clic en
Save.
4
Finalmente, seleccione la Branch y el archivo OpenAPI Spec, y complete el proceso de vinculación.
Referencia de configuración#
| Ajuste | Descripción |
|---|
| Frecuencia de importación | Con qué frecuencia Apidog comprueba e importa actualizaciones desde su fuente de datos. Las opciones incluyen cada 30 minutos, cada hora, diariamente o intervalos personalizados. |
| Formato de origen | El formato de especificación de su archivo de API. Formatos compatibles: OpenAPI (Swagger), ApiDoc o formato nativo de Apidog. |
| URL de origen | El enlace HTTP(S) directo a su archivo de especificación de API. Ejemplo: https://petstore.swagger.io/v2/swagger.json. Debe ser accesible públicamente o estar protegido con Basic Auth. |
| Se ejecuta en | El entorno de ejecución para la tarea de importación. Elija Local Client (se ejecuta cuando su aplicación está abierta) o Runner (se ejecuta en un servidor autoalojado 24/7). |
| Basic auth | Credenciales de nombre de usuario y contraseña si su URL de origen está protegida por HTTP Basic Authentication. Déjelo vacío para URL públicas. |
Modos de ejecución#
Las importaciones programadas requieren un entorno de ejecución para ejecutar el comando de obtención. Elija el modo que mejor se adapte a su flujo de trabajo:1. Cliente local (predeterminado)#
La importación se ejecuta solo cuando su aplicación de escritorio de Apidog está abierta.Requisito: Debe tener el proyecto abierto con permisos de escritura.
Limitación: Si cierra la aplicación o el proyecto, las actualizaciones se pausarán hasta que lo abra de nuevo.
Red: Puede acceder a URL de red interna si su equipo puede acceder a ellas.
Abrir el proyecto en la aplicación web de Apidog también activa la importación programada. Sin embargo, debido a las restricciones de seguridad del navegador, es posible que la aplicación web no pueda acceder a URL de red interna.
2. Runner autoalojado#
La importación se ejecuta en un servidor donde usted ha desplegado un Apidog Runner.Beneficio: Se ejecuta 24/7 independientemente de si usted está en línea.
Caso de uso: Ideal para equipos que necesitan actualizaciones constantes sin intervención manual.
Avanzado: Importar a ramas de sprint#
Puede dirigir su importación a ramas de sprint específicas. De forma predeterminada, los datos se importan a la rama principal.