Uma URL base no Apidog permite extrair a parte repetida dos endereços dos seus endpoints para um gerenciamento unificado.
Por exemplo, se o seu endpoint for https://api.example.com/v1/users, você pode definir https://api.example.com/v1 como a URL base. Então, na definição do seu endpoint, você só precisa escrever /users.
Ao enviar uma requisição, o Apidog concatenará automaticamente a URL base e o caminho do endpoint para formar o endereço de requisição completo. O benefício é que, se o endereço do servidor mudar, você só precisa atualizar a URL base — sem a necessidade de modificar cada endpoint individualmente.
Passos para Definir uma URL Base
Abra seu projeto Apidog e encontre "Gerenciamento de Ambiente" no canto superior direito. O Apidog criará vários ambientes comuns por padrão, como desenvolvimento, teste e produção. Você pode usar essas predefinições ou criar novos ambientes conforme necessário.
Após selecionar um ambiente, você verá a caixa de entrada "URL Base". Insira o endereço base começando com o protocolo (http:// ou https://), como https://test.server.com, ou inclua um número de versão como https://api.example.com/v1.
Certifique-se de não adicionar uma barra final. De acordo com a especificação OpenAPI, a URL base não deve terminar com uma /, enquanto o caminho do endpoint deve começar com uma /.
Recomendamos seguir a especificação OpenAPI para melhor compatibilidade e uma experiência de recurso mais completa no Apidog.
Usando a URL Base em Endpoints
Agora, ao criar um novo endpoint, você só precisa inserir o caminho do endpoint no campo URL. Por exemplo, para testar o endpoint da lista de usuários, basta inserir /users, e o Apidog o combinará automaticamente na URL de requisição completa https://api.example.com/v1/users.
Se o caminho do seu endpoint incluir múltiplos níveis, como /users/123/profile, você pode seguir o mesmo método — o Apidog combinará automaticamente a URL base com o seu caminho para formar a URL de requisição completa.
Nota: Se você inserir um endereço completo (começando com http:// ou https://) na URL do endpoint, a URL base não será usada. O Apidog priorizará o endereço completo que você fornecer.
Gerenciando URLs Base em Múltiplos Ambientes
A maioria dos projetos possui múltiplos ambientes (desenvolvimento, teste, produção), cada um com um endereço de servidor diferente. Você pode definir uma URL base diferente para cada ambiente.
Por exemplo:
- Desenvolvimento:
https://dev-api.example.com/v1 - Teste:
https://test-api.example.com/v1 - Produção:
https://api.example.com/v1
Ao trocar de ambiente no canto superior direito, todos os endpoints usarão automaticamente o endereço do servidor para o ambiente selecionado.
Você também pode escolher o ambiente diretamente na barra de endereço do endpoint, onde a URL base padrão para cada ambiente é exibida. Isso funciona da mesma forma que a troca de ambientes no painel "Gerenciamento de Ambiente".
Nota: Se um ambiente tiver múltiplas URLs base, apenas a padrão aparecerá na barra de endereço. Para usar uma URL base não padrão para endpoints específicos, você precisará configurá-la manualmente dentro do endpoint ou gerenciá-la através de módulos.
Essa configuração de múltiplas URLs base é comum em arquiteturas de microsserviços, onde diferentes endpoints precisam usar diferentes endereços de serviço.
Gerenciando URLs Base em Microsserviços
Se o seu projeto usa uma arquitetura de microsserviços e nem todos os endpoints compartilham a mesma URL base, você tem duas maneiras de gerenciar URLs base no Apidog.
Especificar URLs Base Manualmente Dentro de um Módulo
Você pode agrupar endpoints de diferentes serviços em um único módulo e atribuir diferentes URLs base a pastas específicas ou endpoints individuais. Essa configuração é flexível e funciona bem para equipes que preferem um gerenciamento centralizado.
Por exemplo, você pode configurar um módulo com múltiplas URLs base para diferentes serviços.
Em seguida, atribua a URL base do "Serviço de Usuário" à pasta user e a URL base do "Serviço de Pedido" à pasta order. Todos os endpoints dentro de cada pasta usarão automaticamente a URL base correspondente.
Se você não quiser configurar por pasta, também pode definir a URL base para endpoints individuais. Basta abrir a página “Editar” do endpoint e selecionar a URL base desejada no menu suspenso.
No entanto, à medida que o número de serviços cresce, gerenciar URLs base dessa forma pode se tornar tedioso e mais difícil de manter. Pode funcionar bem para projetos menores, mas projetos maiores podem rapidamente se tornar difíceis de gerenciar.
Para melhor escalabilidade e clareza, recomendamos uma abordagem mais estruturada:
separe cada serviço em seu próprio módulo e defina a URL base no nível do módulo. Isso mantém seu projeto organizado e muito mais fácil de manter.
Organizar Serviços por Módulo (Recomendado)
Crie um módulo separado para cada serviço e configure sua URL base em "Gerenciamento de Ambiente" para cada ambiente. Essa abordagem é mais organizada e ideal para colaboração em equipe e manutenção a longo prazo.
Por exemplo, você pode criar módulos separados para o Serviço de Usuário, Serviço de Pedido e Serviço de Produto, cada um vinculado ao seu próprio arquivo de especificação Swagger ou OpenAPI.
Uma vez que os módulos estejam configurados, vá para a página "Gerenciamento de Ambiente", onde você verá as configurações de URL base bem agrupadas por módulo.
Cada ambiente compartilha a mesma estrutura de módulo, mas a URL base para cada módulo pode variar por ambiente. Isso permite que você atribua URLs base específicas para cada módulo em cada ambiente. Por exemplo:
| Ambiente | Serviço de Produto | Serviço de Usuário | Serviço de Pedido |
|---|---|---|---|
| Produção | https://product.example.com | https://user.example.com | https://order.example.com |
| Teste | http://192.168.1.10:8080 | http://192.168.1.11:8080 | http://192.168.1.12:8080 |
| Desenvolvimento | http://localhost:3000 | http://localhost:3001 | http://localhost:3002 |
Com essa configuração, sempre que você criar um novo endpoint dentro de um módulo, ele usará automaticamente a URL base correta para o ambiente atual — sem a necessidade de selecioná-la manualmente. Por exemplo:
- No "Módulo de Serviço de Usuário & Ambiente de Produção", a URL base padrão é
https://user.example.com. - No "Módulo de Serviço de Pedido & Ambiente de Teste", é
http://192.168.1.12:8080.
Pense no pareamento "Módulo + Ambiente" como um sistema de coordenadas que determina com precisão a URL da requisição. Contanto que seus módulos e ambientes estejam devidamente organizados, o Apidog escolherá automaticamente a URL base correta para cada requisição.
Você não terá que se perguntar, "Qual endereço este endpoint está usando?" — basta selecionar o módulo e o ambiente apropriados, e o Apidog cuida do resto.Pergunte ao ChatGPT
Dicas Práticas para Usar URLs Base
- Se sua API incluir um número de versão, adicione-o diretamente à URL base — por exemplo:
https://api.example.com/v2. Dessa forma, ao atualizar a versão da API, você só precisa atualizar a URL base, e não cada endpoint. - Para casos especiais, como chamar serviços de terceiros, você pode inserir a URL completa diretamente no endpoint. Isso substituirá automaticamente a URL base padrão.
Conclusão
Gerenciar URLs base de forma eficaz é fundamental para manter seus projetos de API limpos, escaláveis e fáceis de manter — especialmente à medida que crescem em complexidade. Quer você esteja trabalhando com um projeto simples de serviço único ou uma grande arquitetura de microsserviços, o Apidog oferece opções flexíveis que se adaptam ao seu fluxo de trabalho.
Ao organizar seus serviços em módulos e configurar URLs base por ambiente, você garante que cada endpoint sempre aponte para o servidor correto — sem sobrecarga manual. Com padrões inteligentes, troca de ambiente e design modular, o Apidog simplifica o processo e elimina as suposições.