Você pode configurar os detalhes da conexão com banco de dados nas configurações do projeto. Depois de configuradas, você pode usar essas conexões durante a depuração e os testes de endpoints adicionando operações de banco de dados nas etapas dos pré/pós-processadores. Isso permite que você leia ou grave no banco de dados de forma integrada.A versão gratuita do Apidog oferece suporte à conexão com os seguintes bancos de dados:SQL Server: oferece suporte ao SQL Server 2014 e versões posteriores
Oracle (Conectar-se a um banco de dados Oracle requer a instalação do Oracle Client) ClickHouse (requer o plano Basic)
MongoDB (requer o plano Basic)
Redis (requer o plano Basic)
1.
Abra Configurações do Projeto → Conexões com Banco de Dados.
2.
Clique em + Novo no canto superior direito para criar uma conexão com banco de dados.
3.
Selecione o tipo de banco de dados entre as opções disponíveis e preencha as informações de conexão necessárias, como host, porta, nome do banco de dados, nome de usuário e senha. Recomenda-se usar variáveis para preencher. Conexões com banco de dados preenchidas inteiramente com variáveis podem ser salvas na nuvem para colaboração.
4.
Além do método de conexão local usando nome de usuário e senha, você também pode estabelecer uma conexão mais segura por meio de túnel SSH para proteger melhor a transmissão de dados.
5.
Clique em Salvar, e essa conexão poderá ser usada nos pré/pós-processadores.
1.
Na guia Executar (Modo de Design) ou na guia Requisição (Modo de Requisição), navegue até os pré/pós-processadores.
2.
Passe o cursor sobre Adicionar Pré-processador ou Adicionar Pós-processador e selecione Operação de Banco de Dados.
3.
Nomeie a operação de banco de dados e configure a conexão com banco de dados. Certifique-se de que a "Conexão com Banco de Dados" selecionada esteja configurada corretamente. Saiba mais. 4.
Insira o comando SQL. Variáveis como {{variables}} são suportadas nos comandos.
5.
Ative Extrair Resultado para Variável (oferece suporte a JSONPath) e habilite Log do Console, se necessário.
6.
Clique em Enviar para executar a requisição do endpoint e verifique o resultado no console.
O Apidog oferece suporte a consultas SQL padrão, mas não oferece suporte a operações SQL complexas, como stored procedures.
Observações Importantes#
Antes de executar operações de banco de dados por meio de requisições, certifique-se de que a conexão com banco de dados configurada esteja devidamente salva:Se a sua conexão com banco de dados usar variáveis e estiver armazenada na nuvem, certifique-se de definir os detalhes reais do banco de dados (como host, nome de usuário, senha etc.) no campo Valor Atual das variáveis relacionadas. Como alternativa, você pode usar o método de definir variável para configurar esses valores dinamicamente.
Se a conexão com banco de dados usar texto fixo e estiver armazenada localmente, você precisará inserir os detalhes reais do banco de dados (como host, nome de usuário, senha etc.) em Configurações do Projeto → Conexão com Banco de Dados.
Mecanismo de Armazenamento e Segurança de Dados#
Atualmente, o Apidog oferece duas formas de armazenar conexões com banco de dados:Armazenado no Apidog Cloud: se a conexão com banco de dados for configurada inteiramente usando variáveis, ela será armazenada como variáveis no servidor em nuvem do Apidog.
Armazenado Localmente: se a conexão com banco de dados for configurada usando texto fixo, ela será armazenada como texto simples no arquivo de configuração local.
Diferenças Entre os Mecanismos de Armazenamento#
| Mecanismo de Armazenamento | Método de Armazenamento | Vantagens | Desvantagens |
|---|
| Nuvem | Usar variáveis na configuração | 1. Permite uma colaboração mais conveniente com membros da equipe.
2. Ao executar cenários de teste via CI, Runner etc., você pode usar variáveis para definir os detalhes da conexão com banco de dados em vez de manter arquivos locais. | ⚠️ Quando texto simples é usado nos valores iniciais das variáveis, dados como nomes de bancos de dados e senhas serão transmitidos em texto simples para os servidores em nuvem do Apidog, representando um risco à segurança dos dados (usar valores atuais para variáveis mantém os dados armazenados localmente, eliminando esse risco). Recomenda-se usar variáveis de cofre para evitar riscos de segurança dos dados. |
| Local | Usar texto fixo na configuração | Armazenado localmente, sem risco de segurança | 1. Colaboração limitada; cada membro da equipe deve configurar a conexão com banco de dados individualmente.
2. Ao executar cenários de teste por meio de CI, Runner ou ferramentas semelhantes, você precisa manter um arquivo local dedicado para conexões com banco de dados. |
Para equilibrar uma excelente experiência do usuário com a segurança dos dados, o Apidog recomenda salvar conexões com banco de dados na nuvem e usar variáveis Vault para garantir a segurança dos dados. É fortemente desencorajado usar texto simples nos valores iniciais de variáveis relacionadas a conexões com banco de dados, pois isso pode levar a riscos significativos de segurança dos dados.
