Opções de importação

Durante a importação manual e a importação agendada, você pode personalizar como os dados são processados usando as Opções de importação.

Configurações gerais

Alvo e destino

Opção	Descrição
Basic Auth	Usado para importações por URL que exigem autenticação com nome de usuário/senha.
Branch de destino	Selecione a branch específica para a qual importar os dados (o padrão é `main`).
Importar para	Escolha importar para uma pasta/módulo existente ou criar um novo.
Gerar caso automaticamente	Se habilitado, o Apidog cria automaticamente um caso de teste de "Sucesso" se a especificação não tiver exemplos.

Importação de ambientes

Se o seu arquivo OpenAPI/Swagger definir vários servidores, habilite Importar servidores como ambientes para criar automaticamente ambientes correspondentes no Apidog.

Segurança e nomenclatura

Esquemas de segurança

Controle como securitySchemes do OpenAPI são tratados.

Autenticação global: Mapeie a segurança global da especificação para a autenticação da pasta Raiz no Apidog.

Autenticação indefinida: Decida o comportamento para endpoints sem segurança específica (por exemplo, "Herdar do pai" ou "Sem autenticação").

Nomenclatura de endpoints

Se um endpoint não tiver um campo Summary descritivo, você pode escolher uma fonte alternativa para o nome:

operationId (Padrão)

URL Path

Extração de Description

Resolução de conflitos

Quando os dados importados correspondem a dados existentes (com base em Método e Caminho), use estas regras para decidir o resultado.

Conflitos de endpoint

Estratégia	Comportamento
Sobrescrever	Substitui completamente o endpoint antigo pelos novos dados.
Manter ambos	Cria uma duplicata; tanto o antigo quanto o novo existem lado a lado.
Ignorar	Ignora o novo endpoint; mantém o antigo inalterado.
Mesclar	Atualização inteligente: retém alterações manuais, como Nome, regras de Mock e Descrições, enquanto atualiza a definição.
Sobrescrever selecionados	Atualiza apenas campos específicos que você selecionar, preservando os outros.

Outros recursos (Schemas / Documentos)

Para documentos Markdown, Schemas e Componentes, aplicam-se opções semelhantes de Sobrescrever versus Mesclar.

Lógica avançada de sincronização

Sincronização de pastas

Quando um endpoint importado corresponde a um endpoint existente no projeto, mas seus locais de pasta diferem:

Manter pasta existente: Ignora o caminho da pasta no arquivo importado. O endpoint permanece na pasta atual dele no Apidog.

Atualizar pasta do endpoint: Move o endpoint para a estrutura de pastas definida no arquivo importado.

Limpeza de recursos

Decida o que acontece com recursos que existiam no projeto, mas estão ausentes no novo arquivo de importação.

Não excluir (Seguro): Mantém recursos órfãos no seu projeto.

Excluir (Sincronização): Remove qualquer recurso que não esteja presente no novo arquivo. Use com cautela para manter um espelho exato da especificação.

Opções de importação

Configurações gerais#

Alvo e destino#

Importação de ambientes#

Segurança e nomenclatura#

Esquemas de segurança#

Nomenclatura de endpoints#

Resolução de conflitos#

Conflitos de endpoint#

Outros recursos (Schemas / Documentos)#

Lógica avançada de sincronização#

Sincronização de pastas#

Limpeza de recursos#