Como Compartilhar Cabeçalhos (por exemplo, Token) na Documentação Online do Apidog?

Tenho que inserir manualmente o mesmo cabeçalho sempre que uso “Try It” para testar uma API. Há uma forma de compartilhá-lo automaticamente?

Sim. Recomenda-se usar variáveis para compartilhar cabeçalhos entre requisições de API. Veja duas abordagens comuns:

Método 1: Use uma variável diretamente no cabeçalho da API

Defina o cabeçalho assim na definição da sua API:

Ao usar o recurso “Try It” na documentação online, os usuários só precisam inserir o valor de ACCESS_TOKEN uma vez no topo. Todas as APIs que fazem referência a {{ACCESS_TOKEN}} preencherão automaticamente o valor — sem necessidade de inseri-lo repetidamente.

Método 2: Defina parâmetros de cabeçalho globais usando uma variável

Acesse Gerenciamento de Ambientes → Parâmetros Globais

Adicione um parâmetro do tipo cabeçalho, por exemplo:

As APIs no projeto usarão esse parâmetro global por padrão. Você também pode optar por habilitá-lo ou desabilitá-lo para APIs específicas.

A documentação online herdará automaticamente o valor da variável, permitindo que várias APIs o compartilhem.

Quer você defina a variável diretamente no cabeçalho da API ou faça referência a ela por meio de parâmetros globais, desde que o mesmo nome de variável (por exemplo, {{ACCESS_TOKEN}}) seja usado, você só precisará inseri-lo uma vez na documentação online. Em seguida, ele será compartilhado entre todas as requisições relevantes — melhorando bastante a experiência de teste.

Como Compartilhar Cabeçalhos (por exemplo, Token) na Documentação Online do Apidog?

Método 1: Use uma variável diretamente no cabeçalho da API#

Método 2: Defina parâmetros de cabeçalho globais usando uma variável#

Método 1: Use uma variável diretamente no cabeçalho da API

Método 2: Defina parâmetros de cabeçalho globais usando uma variável