Pode configurar os detalhes da ligação à base de dados nas definições do projeto. Depois de configuradas, pode utilizar estas ligações durante a depuração e o teste de endpoints adicionando operações de base de dados nos passos dos pré/pós-processadores. Isto permite-lhe ler ou escrever na base de dados de forma integrada.A versão gratuita do Apidog suporta a ligação às seguintes bases de dados:SQL Server: suporta SQL Server 2014 e versões posteriores
Oracle (a ligação a uma base 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)
Configurar a Ligação à Base de Dados#
Siga estes passos para configurar uma ligação à base de dados no Apidog:1.
Abra Definições do Projeto → Ligações à Base de Dados.
2.
Clique em + Novo no canto superior direito para criar uma ligação à base de dados.
3.
Selecione o tipo de base de dados entre as opções disponíveis e preencha as informações de ligação necessárias, como host, porta, nome da base de dados, nome de utilizador e palavra-passe. Recomenda-se a utilização de variáveis para preencher estes campos. As ligações à base de dados preenchidas inteiramente com variáveis podem ser guardadas na nuvem para colaboração.
4.
Além do método de ligação local com nome de utilizador e palavra-passe, também pode estabelecer uma ligação mais segura através de um túnel SSH para proteger melhor a transmissão de dados.
5.
Clique em Guardar, e esta ligação poderá ser utilizada nos pré/pós-processadores.
Utilizar a Ligação à Base de Dados#
Pode adicionar "Operações de Base de Dados" nos pré/pós-processadores de um pedido de endpoint para referenciar uma ligação à base de dados. Depois de a adicionar, pode especificar uma ligação à base de dados em "Operações de Base de Dados".Abaixo estão os passos específicos para operações de base de dados:1.
No separador Executar (Modo de Design) ou no separador Pedido (Modo de Pedido), navegue até aos pré/pós-processadores.
2.
Passe o cursor sobre Adicionar Pré-processador ou Adicionar Pós-processador e selecione Operação de Base de Dados.
3.
Dê um nome à operação de base de dados e configure a ligação à base de dados. Certifique-se de que a "Ligação à Base de Dados" selecionada está corretamente configurada. Saiba mais. 4.
Introduza o comando SQL. Variáveis como {{variables}} são suportadas nos comandos.
5.
Ative Extrair Resultado para Variável (suporta JSONPath) e alterne Registo da Consola, se necessário.
6.
Clique em Enviar para executar o pedido do endpoint e verifique o resultado na consola.
O Apidog suporta consultas SQL padrão, mas não suporta operações SQL complexas, como procedimentos armazenados.
Notas Importantes#
Antes de executar operações de base de dados através de pedidos, certifique-se de que a ligação à base de dados configurada está devidamente guardada:Se a sua ligação à base de dados utilizar variáveis e estiver armazenada na nuvem, certifique-se de que define os detalhes reais da base de dados (como host, nome de utilizador, palavra-passe, etc.) no campo Valor Atual das variáveis relacionadas. Em alternativa, pode utilizar o método de definição de variável para configurar estes valores dinamicamente.
Se a ligação à base de dados utilizar texto fixo e estiver armazenada localmente, tem de introduzir os detalhes reais da base de dados (como host, nome de utilizador, palavra-passe, etc.) em Definições do Projeto → Ligação à Base de Dados.
Mecanismo de Armazenamento e Segurança dos Dados#
Atualmente, o Apidog oferece duas formas de armazenar ligações à base de dados:Armazenado na Apidog Cloud: se a ligação à base de dados for configurada inteiramente com variáveis, será armazenada como variáveis no servidor cloud do Apidog.
Armazenado Localmente: se a ligação à base de dados for configurada com texto fixo, será armazenada como texto simples no ficheiro de configuração local.
Diferenças Entre Mecanismos de Armazenamento#
| Mecanismo de Armazenamento | Método de Armazenamento | Vantagens | Desvantagens |
|---|
| Nuvem | Utilizar variáveis na configuração | 1. Permite uma colaboração mais conveniente com membros da equipa.
2. Ao executar cenários de teste via CI, Runner, etc., pode utilizar variáveis para definir os detalhes da ligação à base de dados em vez de manter ficheiros locais. | ⚠️ Quando texto simples é utilizado nos valores iniciais das variáveis, dados como nomes de bases de dados e palavras-passe serão transmitidos em texto simples para os servidores cloud do Apidog, representando um risco de segurança dos dados (a utilização de valores atuais para variáveis mantém os dados armazenados localmente, eliminando este risco). Recomenda-se a utilização de variáveis de cofre para evitar riscos de segurança dos dados. |
| Local | Utilizar texto fixo na configuração | Armazenado localmente, sem risco de segurança | 1. Colaboração deficiente; cada membro da equipa deve configurar a ligação à base de dados individualmente.
2. Ao executar cenários de teste através de CI, Runner ou ferramentas semelhantes, tem de manter um ficheiro local dedicado para ligações à base de dados. |
Para equilibrar uma excelente experiência de utilizador com a segurança dos dados, o Apidog recomenda guardar as ligações à base de dados na nuvem e utilizar variáveis Vault para garantir a segurança dos dados. É fortemente desaconselhado utilizar texto simples nos valores iniciais das variáveis relacionadas com ligações à base de dados, pois isto pode originar riscos significativos de segurança dos dados.
