Módulo

Em um projeto do Apidog, você pode usar módulos para organizar seus endpoints. Um módulo é semelhante a um "serviço" na arquitetura técnica, projetado para ajudar você a gerenciar e apresentar endpoints com mais eficiência — especialmente em sistemas baseados em microsserviços. Cada módulo inclui seu próprio conjunto de endpoints relacionados, componentes (como schemas, respostas e esquemas de segurança) e URLs base (uma para cada ambiente).

Cada módulo corresponde a um arquivo de especificação Swagger/OpenAPI completo e independente.

Quando Usar Módulos

Use módulos para organizar seus endpoints quando:

Serviços fortemente relacionados: Por exemplo, em um projeto de IA: um módulo para endpoints de geração de texto, outro para endpoints de geração de imagem e um para endpoints de fala.

Microsserviços: Por exemplo, em um projeto de e-commerce, você pode ter serviços de autenticação, pedidos e produtos.

Múltiplas versões de API: Por exemplo, seu projeto expõe diferentes versões de API para usuários externos, como Legacy, LTS e Latest.

Criando um Módulo

No projeto, passe o cursor sobre a parte superior da árvore de pastas e clique no botão +. No menu suspenso, selecione New Module.

Insira o nome do módulo e clique em Save. O novo módulo aparecerá na árvore de pastas. Clique no módulo para visualizar seus detalhes, incluindo:

Estatísticas de dados dos recursos no módulo

Cobertura de caso de endpoint e cenário de teste

Opções de exportação para endpoints no módulo

Configurações de fonte de dados

Variáveis do módulo – semelhantes a variáveis de ambiente, mas acessíveis apenas dentro das requisições de endpoint deste módulo.

Configurando a URL Base para Cada Módulo

Depois que um módulo é criado, ele aparecerá automaticamente na página de Gerenciamento de Ambientes. Você pode atribuir uma URL Base para cada ambiente dentro do módulo recém-adicionado.

Configurando a URL base do módulo no gerenciamento de ambientes

Usando a URL Base Correta ao Fazer Requisições

Por padrão, as requisições de endpoint de cada módulo usarão automaticamente a URL Base definida para esse módulo no ambiente atual, combinada com o caminho do endpoint. Endpoints de um módulo não podem usar a URL Base de outro módulo para enviar requisições.

Uso automático da URL base em requisições

Padrão de Uso Legado

Se um único módulo contiver vários serviços (várias URLs Base), você poderá especificar manualmente qual URL Base usar no nível da pasta ou do endpoint dentro do módulo.

No entanto, essa abordagem fazia parte de um padrão de uso mais antigo no Apidog e não é recomendada desde a versão 2.7.16. Em vez disso, sugerimos dividir os serviços em módulos separados, cada um com sua própria URL Base.

Saiba mais: Ambientes e serviços

Quando Usar Módulos#

Criando um Módulo#

Configurando a URL Base para Cada Módulo#

Usando a URL Base Correta ao Fazer Requisições#

Quando Usar Módulos

Criando um Módulo

Configurando a URL Base para Cada Módulo

Usando a URL Base Correta ao Fazer Requisições