How Can Document Users Modify the Base URL in Shared Docs?

In the published docs or quickly shared docs of Apidog, if you want the document users to be able to set and modify the Base URL, it can be easily achieved by setting variables. The specific operation steps are as follows:

Create and reference variables

In the Apidog project, go to a certain "Environment" page, click "Add Variable", and enter the variable name (for example, "BaseURL"). In the URL input box corresponding to the "Base URL" of the environment, use the variable reference (for example, {{BaseURL}}) to replace the specific URL address. This associates the Base URL with the created variable.

Select Environment

Choose the corresponding environment when publishing the documentation.

Access the document

After the document is published and shared with users, the users can see the place where the variable is referenced on the endpoint. When the mouse hovers over the variable reference, it will prompt the user to set the variable value.

Modify the variable value

Click on the variable, and the variable setting window will pop up automatically. The user just needs to fill in the required actual value.

After saving, the paths displayed on the document and the actual requests will automatically apply the updated variable value.

This method allows users to customize the Base URL to access their specific data.