Ao efetuar pedidos de API, é frequentemente necessário alternar entre ambientes de desenvolvimento, teste e produção. O Apidog torna conveniente enviar pedidos para diferentes ambientes — basta clicar e selecionar o ambiente pretendido no canto superior direito da interface.Um ambiente do Apidog consiste em dois elementos principais:1.
URL base: Mantém o destino de entrega do pedido.
2.
Variáveis: Grupos de variáveis que podem ser referenciadas em pedidos ou scripts.
Criar um Ambiente#
1
Abrir a Gestão de AmbientesClique no botão Gestão de Ambientes ≡ no canto superior direito da interface.
2
Criar Novo AmbienteClique no último item da lista do lado esquerdo com a etiqueta Novo Ambiente.
3
Configurar AmbienteIntroduza um nome para o seu novo ambiente. Adicione a URL base e as variáveis. 5
Selecionar AmbientePara utilizar o novo ambiente, selecione-o no seletor de ambientes no canto superior direito da interface. Isto torna-o o ambiente ativo e define todas as variáveis para os valores especificados no ambiente.
O Apidog mantém uma separação clara entre ambientes e URLs base. Os ambientes representam diferentes fases de implementação (desenvolvimento, teste, produção), enquanto as URLs base são configuradas dentro de cada ambiente. Esta separação proporciona flexibilidade ao gerir 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 tratarem cada URL base como um único ambiente.
URLs Base#
A URL base é a funcionalidade principal num ambiente do Apidog. No Apidog, o caminho de um endpoint começa normalmente com uma barra (/) e não inclui a URL base. Ao enviar um pedido, o Apidog antepõe a URL base de destino ao caminho do endpoint.Um formato normalizado de URL base começa com o protocolo e exclui a barra final (/).Cada URL base corresponde a um Módulo específico. Na maioria dos casos, um endpoint utilizará a URL base do respetivo módulo para enviar pedidos.Por exemplo, se a URL base do módulo predefinido para o ambiente de Produção for http://abc.com/v1 e o caminho do seu endpoint for /pet, então, ao enviar um pedido no ambiente de Produção, o URL real do pedido enviado seria:Se o caminho do endpoint começar com http:// ou https://, a URL base não será anexada. No entanto, a codificação rígida de URLs completos em endpoints é geralmente desaconselhada.
No Apidog, existe uma variável de ambiente especial chamada BASE_URL, que armazena a URL base do "Servidor Predefinido" do ambiente atual. É geralmente desaconselhado utilizar esta variável diretamente.Para scripts personalizados:Recomendado: Utilize pm.request.getBaseUrl() para obter a URL base do endpoint atual.
Evitar: Utilizar pm.environment.get('BASE_URL'), pois poderá não captar corretamente a URL base se o endpoint não ocupar o "Servidor Predefinido".
BASE_URL, esta substituirá a BASE_URL predefinida pelo sistema.Nota: Os scripts não podem modificar a própria configuração da URL base. O comando pm.environment.set('BASE_URL', 'My_url') apenas criará uma variável chamada BASE_URL. Endpoints de utilizador: https://user.example.com
Endpoints de encomendas: https://order.example.com
Endpoints de produtos: https://product.example.com
1
Criar MódulosNo topo da árvore de pastas da API, adicione vários módulos correspondentes aos seus serviços. 2
Configurar URLs BaseEm Gestão de Ambientes, verá campos para definir a URL base de cada módulo. Introduza os URLs para cada ambiente e clique em Guardar. 3
Definir URL Base do MóduloNas definições da pasta raiz de um módulo, escolha que URL base os endpoints do módulo devem utilizar.Definições Predefinidas: Utiliza a primeira URL base listada para esse módulo (Recomendado).
Especificar Manualmente: Selecione manualmente outra URL base. (Não recomendado para a maioria dos casos).
4
HerançaEm subpastas ou endpoints individuais, também pode especificar a URL base.Herdar dos Elementos Superiores: Segue a pasta superior (Predefinição).
Especificar Manualmente: Substitui para itens específicos.
5
Enviar PedidosDepois de configurado, basta clicar em Enviar. O Apidog determina a URL base adequada com base nas definições do módulo e do ambiente.
Adicionar Variáveis de Ambiente#
Ao adicionar uma variável a um ambiente, pode especificar dois valores:Valor inicial: Partilhado com a equipa.
Valor atual: Armazenado localmente no seu computador.
Alternar Entre Ambientes#
O Apidog mostra o ambiente atual no seletor de ambientes no canto superior direito da área de trabalho. Sempre que efetuar um pedido ou executar um script, o Apidog utilizará os valores atuais de todas as variáveis no ambiente selecionado.Para alternar, basta escolher um ambiente diferente no seletor.Endpoint: A especificação da API (o caminho começa normalmente com /).
Pedido: O pedido HTTP real enviado (inclui o URL completo).
{{Base_url}}, se necessário.Migração de Ambientes#
No Apidog, o Valor inicial das variáveis é sincronizado dentro da equipa, enquanto o Valor atual é armazenado apenas localmente. Isto significa que os valores atuais não são transferidos para outros dispositivos.O Apidog fornece funcionalidade de exportação/importação para migrar ambientes (incluindo valores atuais locais) entre computadores.1
ExportarNa Gestão de Ambientes, passe o cursor sobre ... junto ao ambiente e clique em Exportar para obter um ficheiro JSON. 2
ImportarNo computador de destino, abra a Gestão de Ambientes, passe o cursor sobre ..., clique em Importar e selecione o ficheiro JSON.
Âmbito de Visibilidade dos Ambientes#
Pode criar Ambientes Privados para variáveis que não pretende partilhar.No canto superior direito das definições do ambiente, defina o âmbito de visibilidade.Partilhado: Visível para a equipa (Predefinição).
Privado: Visível apenas para si.
Os Ambientes Privados partilham a mesma lista de Serviços (URLs base) que os outros ambientes. Adicionar ou remover serviços num Ambiente Privado afetará todos os ambientes em simultâneo.
FAQ#
Como obter a URL base do serviço num script personalizado?Utilize pm.request.getBaseUrl() para obter a URL base do endpoint atual. 
