Como os usuários da documentação podem modificar a URL base em documentações compartilhadas?

Nas documentações publicadas ou compartilhadas rapidamente do Apidog, se você quiser que os usuários da documentação possam definir e modificar a URL base, isso pode ser facilmente feito por meio da configuração de variáveis. As etapas específicas da operação são as seguintes:

Criar e referenciar variáveis

No projeto do Apidog, acesse uma determinada página de "Ambiente", clique em "Adicionar variável" e insira o nome da variável (por exemplo, "BaseURL"). Na caixa de entrada de URL correspondente à "URL base" do ambiente, use a referência da variável (por exemplo, {{BaseURL}}) para substituir o endereço de URL específico. Isso associa a URL base à variável criada.

Selecionar ambiente

Escolha o ambiente correspondente ao publicar a documentação.

Acessar a documentação

Depois que a documentação for publicada e compartilhada com os usuários, eles poderão ver o local em que a variável é referenciada no endpoint. Quando o mouse passar sobre a referência da variável, o usuário será solicitado a definir o valor da variável.

Modificar o valor da variável

Clique na variável, e a janela de configuração da variável será exibida automaticamente. O usuário só precisa preencher o valor real necessário.

Após salvar, os caminhos exibidos na documentação e as requisições reais aplicarão automaticamente o valor atualizado da variável.

Este método permite que os usuários personalizem a URL base para acessar seus dados específicos.