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

Tenho de introduzir manualmente o mesmo cabeçalho sempre que utilizo “Try It” para testar uma API. Existe alguma forma de o partilhar automaticamente?

Sim. Recomenda-se a utilização de variáveis para partilhar cabeçalhos entre pedidos de API. Eis duas abordagens comuns:

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

Defina o cabeçalho desta forma na sua definição de API:

Ao utilizar a funcionalidade “Try It” na documentação online, os utilizadores só precisam de introduzir o valor de ACCESS_TOKEN uma vez na parte superior. Todas as APIs que referenciem {{ACCESS_TOKEN}} preencherão automaticamente o valor — sem necessidade de o introduzir repetidamente.

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

Aceda a Gestão de Ambientes → Parâmetros Globais

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

As APIs no projeto utilizarão este parâmetro global por predefinição. Também pode optar por ativá-lo ou desativá-lo para APIs específicas.

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

Quer defina a variável diretamente no cabeçalho da API ou a referencie através de parâmetros globais, desde que seja utilizado o mesmo nome de variável (por exemplo, {{ACCESS_TOKEN}}), só precisa de a introduzir uma vez na documentação online. Em seguida, será partilhada entre todos os pedidos relevantes, melhorando significativamente a experiência de teste.

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

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

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

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

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