Ao fazer requisições de API, muitas vezes é necessário alternar entre ambientes de desenvolvimento, teste e produção. O Apidog facilita o envio de requisições para diferentes ambientes — você só precisa clicar e selecionar o ambiente desejado no canto superior direito da interface.Um ambiente do Apidog consiste em dois elementos principais:1.
Base URL: Mantém o destino de entrega da requisição.
2.
Variáveis: Grupos de variáveis que podem ser referenciadas em requisições ou scripts.
Criar um Ambiente#
1
Abrir o Gerenciamento de AmbientesClique no botão Gerenciamento de Ambientes ≡ no canto superior direito da interface.
2
Criar Novo AmbienteClique no último item da lista à esquerda, chamado Novo Ambiente.
3
Configurar AmbienteInsira um nome para o seu novo ambiente. Adicione a Base URL e as variáveis. 5
Selecionar AmbientePara usar o novo ambiente, selecione-o no seletor de ambiente no canto superior direito da interface. Isso o torna o ambiente ativo e define todas as variáveis com os valores especificados no ambiente.
O Apidog mantém uma separação clara entre ambientes e Base URLs. Ambientes representam diferentes estágios de implantação (desenvolvimento, teste, produção), enquanto as Base URLs são configuradas dentro de cada ambiente. Essa separação oferece flexibilidade ao gerenciar vários serviços ou microsserviços em diferentes ambientes.Em contraste, os ambientes do Apidog refletem diretamente ambientes reais, como desenvolvimento, teste e produção, em vez de tratar cada Base URL como um único ambiente.
Base URLs#
A Base URL é o principal recurso em um ambiente do Apidog. No Apidog, um caminho de endpoint geralmente começa com uma barra (/) e não inclui a Base URL. Ao enviar uma requisição, o Apidog acrescenta a Base URL de destino antes do caminho do endpoint.Um formato padronizado de Base URL começa com o protocolo e exclui a barra final (/).Cada Base URL corresponde a um Módulo específico. Na maioria dos casos, um endpoint usará a Base URL do seu módulo para enviar requisições.Por exemplo, se a Base URL do módulo padrão para o ambiente de Produção for http://abc.com/v1 e o caminho do seu endpoint for /pet, então, ao enviar uma requisição no ambiente de Produção, a URL real da requisição enviada seria:Se o caminho do endpoint começar com http:// ou https://, a Base URL não será anexada. No entanto, geralmente não é recomendável codificar URLs completas diretamente em endpoints.
No Apidog, há uma variável de ambiente especial chamada BASE_URL, que armazena a Base URL do "Default Server" do ambiente atual. Geralmente, não é recomendável usar essa variável diretamente.Para scripts personalizados:Recomendado: Use pm.request.getBaseUrl() para obter a Base URL do endpoint atual.
Evite: Usar pm.environment.get('BASE_URL'), pois isso pode não capturar corretamente a Base URL se o endpoint não ocupar o "Default Server".
BASE_URL, ela substituirá o BASE_URL predefinido do sistema.Observação: Scripts não podem modificar a configuração da Base URL em si. O comando pm.environment.set('BASE_URL', 'My_url') apenas criará uma variável chamada BASE_URL. Endpoints de usuário: https://user.example.com
Endpoints de pedido: https://order.example.com
Endpoints de produto: https://product.example.com
1
Criar MódulosNa parte superior da árvore de pastas da API, adicione vários módulos correspondentes aos seus serviços. 2
Configurar Base URLsEm Gerenciamento de Ambientes, você verá campos para definir a Base URL de cada módulo. Insira as URLs para cada ambiente e clique em Salvar. 3
Definir a Base URL do MóduloNas configurações da pasta raiz de um módulo, escolha qual Base URL os endpoints do módulo devem usar.Configurações Padrão: Usa a primeira Base URL listada para esse módulo (recomendado).
Especificar Manualmente: Selecione outra Base URL manualmente. (Não recomendado para a maioria dos casos).
4
HerançaEm subpastas ou endpoints individuais, você também pode especificar a Base URL.Herdar dos Pais: Segue a pasta pai (padrão).
Especificar Manualmente: Substitui para itens específicos.
5
Enviar RequisiçõesDepois de configurado, basta clicar em Enviar. O Apidog determina a Base URL correta com base nas configurações de módulo e ambiente.
Adicionar Variáveis de Ambiente#
Ao adicionar uma variável a um ambiente, você pode especificar dois valores:Valor inicial: Compartilhado com a equipe.
Valor atual: Armazenado localmente na sua máquina.
Alternar Entre Ambientes#
O Apidog mostra o ambiente atual no seletor de ambiente no canto superior direito da área de trabalho. Sempre que você fizer uma requisição ou executar um script, o Apidog usará os valores atuais de todas as variáveis no ambiente selecionado.Para alternar, basta escolher um ambiente diferente no seletor.Endpoints vs. RequisiçõesEndpoint: A especificação da API (o caminho geralmente começa com /).
Requisição: A requisição HTTP real enviada (inclui a URL completa).
{{Base_url}} se necessário. Migração de Ambientes#
No Apidog, o Valor inicial das variáveis é sincronizado dentro da equipe, enquanto o Valor atual é armazenado apenas localmente. Isso significa que os valores atuais não são transferidos para outros dispositivos.O Apidog oferece funcionalidade de exportação/importação para migrar ambientes (incluindo valores atuais locais) entre máquinas.1
ExportarNo Gerenciamento de Ambientes, passe o cursor sobre ... ao lado do ambiente e clique em Exportar para obter um arquivo JSON. 2
ImportarNo computador de destino, abra o Gerenciamento de Ambientes, passe o cursor sobre ..., clique em Importar e selecione o arquivo JSON.
Escopo de Visibilidade dos Ambientes#
Você pode criar Ambientes Privados para variáveis que não deseja compartilhar.No canto superior direito das configurações do ambiente, defina o escopo de visibilidade.Compartilhado: Visível para a equipe (padrão).
Privado: Visível apenas para você.
Ambientes Privados compartilham a mesma lista de Serviços (Base URLs) que outros ambientes. Adicionar ou remover serviços em um Ambiente Privado afetará todos os ambientes simultaneamente.
Perguntas Frequentes#
Como obter a Base URL do serviço em um script personalizado?Use pm.request.getBaseUrl() para recuperar a Base URL do endpoint atual. 
