Como podem os utilizadores da documentação modificar a URL Base em documentação partilhada?

Na documentação publicada ou na documentação partilhada rapidamente do Apidog, se pretender que os utilizadores da documentação possam definir e modificar a URL Base, isso pode ser facilmente conseguido através da configuração de variáveis. Os passos específicos da operação são os seguintes:

Criar e referenciar variáveis

No projeto Apidog, aceda a uma determinada página de "Ambiente", clique em "Adicionar variável" e introduza o nome da variável (por exemplo, "BaseURL"). Na caixa de introdução de URL correspondente à "URL Base" do ambiente, utilize a referência da variável (por exemplo, {{BaseURL}}) para substituir o endereço URL específico. Isto associa a URL Base à variável criada.

Selecionar ambiente

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

Aceder à documentação

Depois de a documentação ser publicada e partilhada com os utilizadores, estes podem ver o local onde a variável é referenciada no endpoint. Quando o rato passa sobre a referência da variável, será solicitado ao utilizador que defina 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á apresentada automaticamente. O utilizador só precisa de preencher o valor real necessário.

Após guardar, os caminhos apresentados na documentação e os pedidos reais aplicarão automaticamente o valor atualizado da variável.

Este método permite que os utilizadores personalizem a URL Base para aceder aos seus dados específicos.