Importação Agendada (Vincular Fontes de Dados)

A Importação Agendada sincroniza automaticamente suas especificações de API de fontes externas para o Apidog em intervalos regulares. Este recurso é ideal para equipes que mantêm suas especificações de API em sistemas externos (como repositórios Git ou endpoints Swagger), mas desejam aproveitar os recursos avançados de depuração e testes do Apidog sem reimportações manuais.

Com a Importação Agendada, você pode:

Manter uma única fonte da verdade para suas especificações de API no seu sistema de controle de versão preferido

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

Importar de várias fontes, incluindo GitHub, GitLab, Azure DevOps e URLs diretas

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

Como Configurar

Navegue até Configurações

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

Crie uma Fonte de Dados

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

Configure as Definições

Preencha os detalhes da fonte de dados (URL, Frequência etc.). Vá para a próxima seção para obter detalhes sobre como vincular um repositório git.

Salve e Ative

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

O Apidog oferece suporte à criação de várias fontes de dados em um único projeto, cada uma sincronizando e importando para pastas diferentes.

Vincular Repositório Git

O Apidog oferece suporte à vinculação de repositórios git de:

Github

GitLab e

Azure DevOps

Para vincular um repositório git, siga estas etapas.

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

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

Quando você for redirecionado de volta ao Apidog, selecione sua Organization e Repository e clique em Save.

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

Referência de Configuração

Configuração	Descrição
Frequência de importação	Com que frequência o Apidog verifica e importa atualizações da sua fonte de dados. As opções incluem a cada 30 minutos, de hora em hora, diariamente ou intervalos personalizados.
Formato de origem	O formato de especificação do seu arquivo de API. Formatos compatíveis: `OpenAPI` (Swagger), `ApiDoc` ou formato nativo `Apidog`.
URL de origem	O link HTTP(S) direto para o seu arquivo de especificação de API. Exemplo: `https://petstore.swagger.io/v2/swagger.json`. Deve ser acessível publicamente ou protegido com Basic Auth.
Executa em	O ambiente de execução para a tarefa de importação. Escolha `Local Client` (executa quando seu app está aberto) ou `Runner` (executa em um servidor auto-hospedado 24 horas por dia, 7 dias por semana).
Basic auth	Credenciais de nome de usuário e senha se sua URL de origem estiver protegida por HTTP Basic Authentication. Deixe em branco para URLs públicas.

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

Modos de Execução

Importações agendadas exigem um ambiente de execução para executar o comando de busca. Escolha o modo que melhor se adapta ao seu fluxo de trabalho:

1. Local Client (Padrão)

A importação é executada somente quando seu app desktop do Apidog está aberto.

Requisito: Você deve estar com o projeto aberto e ter permissões de gravação.

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

Rede: Pode acessar URLs de rede interna se o seu computador puder acessá-las.

Abrir o projeto no Apidog Web App também aciona a importação agendada. No entanto, devido a restrições de segurança do navegador, o Web App pode não conseguir acessar URLs de rede interna.

2. Self-hosted Runner

A importação é executada em um servidor no qual você implantou um Apidog Runner.

Benefício: Executa 24 horas por dia, 7 dias por semana, independentemente de você estar online.

Caso de uso: Ideal para equipes que precisam de atualizações consistentes sem intervenção manual.

Saiba mais sobre como implantar um Self-hosted Runner.

Avançado: Importar para Branches de Sprint

Você pode direcionar branches de sprint específicas para sua importação. Por padrão, os dados são importados para a Main Branch.

Para obter o fluxo de trabalho detalhado, consulte Como 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. Local Client (Padrão)#

2. Self-hosted Runner#

Avançado: Importar para Branches de Sprint#

Como Configurar

Vincular Repositório Git

Referência de Configuração

Modos de Execução

1. Local Client (Padrão)

2. Self-hosted Runner

Avançado: Importar para Branches de Sprint