Importação Agendada (Vincular Fontes de Dados)

A Importação Agendada sincroniza automaticamente as suas especificações de API a partir de fontes externas para o Apidog em intervalos regulares. Esta funcionalidade é ideal para equipas que mantêm as suas especificações de API em sistemas externos (como repositórios Git ou endpoints Swagger), mas que pretendem tirar partido das poderosas capacidades de depuração e teste do Apidog sem reimportações manuais.

Com a Importação Agendada, pode:

Manter uma única fonte de verdade para as suas especificações de API no seu sistema de controlo de versões preferido

Sincronizar automaticamente alterações em intervalos personalizáveis (a cada 30 minutos, de hora a hora, diariamente, etc.)

Importar a partir de várias fontes, incluindo GitHub, GitLab, Azure DevOps e URLs diretos

Manter a sua equipa alinhada com as alterações mais recentes da API sem intervenção manual

Como Configurar

Navegue até às Definições

Vá a Settings -> Import Data -> Scheduled Import (Bind Data Sources).

Criar Fonte de Dados

Clique em "New" para adicionar uma configuração.

Configurar Definições

Preencha os detalhes da fonte de dados (URL, Frequência, etc.). Consulte a secção seguinte para obter detalhes sobre como vincular um repositório git.

Guardar e Ativar

Clique em Save. A importação será agora executada automaticamente com base nas suas definições de frequência.

O Apidog suporta a criação de várias fontes de dados num único projeto, cada uma sincronizando e importando para pastas diferentes.

Vincular Repositório Git

O Apidog suporta a vinculação de repositórios git a partir de:

GitHub

GitLab e

Azure DevOps

Para vincular um repositório git, siga estes passos.

Selecione a opção Git Repository na caixa de diálogo Bind Data Sources e crie uma ligação ao repositório.

Depois de selecionar a sua plataforma de controlo de versões preferida, siga as instruções para conceder ao Apidog acesso aos seus repositórios.

Quando for redirecionado de volta para o Apidog, selecione a sua Organization e o seu Repository e, em seguida, clique em Save.

Por fim, selecione o Branch e o ficheiro OpenAPI Spec e conclua o processo de vinculação.

Referência de Configuração

Definição	Descrição
Frequência de importação	Com que frequência o Apidog verifica e importa atualizações a partir da sua fonte de dados. As opções incluem a cada 30 minutos, de hora a hora, diariamente ou intervalos personalizados.
Formato da fonte	O formato de especificação do seu ficheiro de API. Formatos suportados: `OpenAPI` (Swagger), `ApiDoc` ou formato nativo `Apidog`.
URL da fonte	A ligação HTTP(S) direta para o seu ficheiro de especificação de API. Exemplo: `https://petstore.swagger.io/v2/swagger.json`. Deve estar publicamente acessível ou protegido com Basic Auth.
Executa em	O ambiente de execução da tarefa de importação. Escolha `Local Client` (executa quando a sua aplicação está aberta) ou `Runner` (executa num servidor autoalojado 24/7).
Autenticação básica	Credenciais de nome de utilizador e palavra-passe se o seu URL da fonte estiver protegido por Autenticação Básica HTTP. Deixe em branco para URLs públicos.

Para obter mais opções de importação, consulte Opções de importação.

Modos de Execução

As importações agendadas requerem um ambiente de execução para executar o comando de obtenção. Escolha o modo que melhor se adequa ao seu fluxo de trabalho:

1. Cliente Local (Predefinido)

A importação é executada apenas quando a sua aplicação de ambiente de trabalho Apidog está aberta.

Requisito: Deve ter o projeto aberto com permissões de escrita.

Limitação: Se fechar a aplicação ou o projeto, as atualizações serão pausadas até que o abra novamente.

Rede: Pode aceder a URLs de rede interna se o seu computador conseguir aceder aos mesmos.

Abrir o projeto na Aplicação Web do Apidog também aciona a importação agendada. No entanto, devido a restrições de segurança do navegador, a Aplicação Web poderá não conseguir aceder a URLs de rede interna.

2. Runner Autoalojado

A importação é executada num servidor onde implementou um Apidog Runner.

Benefício: Executa 24/7, independentemente de estar online.

Caso de utilização: Ideal para equipas que necessitam de atualizações consistentes sem intervenção manual.

Saiba mais sobre como implementar um Runner Autoalojado.

Avançado: Importar para Branches de Sprint

Pode direcionar branches de sprint específicas para a sua importação. Por predefinição, os dados são importados para a Main Branch.

Para obter um fluxo de trabalho detalhado, consulte Importar dados para branches de sprint.

Importação Agendada (Vincular Fontes de Dados)

Como Configurar#

Vincular Repositório Git#

Referência de Configuração#

Modos de Execução#

1. Cliente Local (Predefinido)#

2. Runner Autoalojado#

Avançado: Importar para Branches de Sprint#

Como Configurar

Vincular Repositório Git

Referência de Configuração

Modos de Execução

1. Cliente Local (Predefinido)

2. Runner Autoalojado

Avançado: Importar para Branches de Sprint