¿Cómo pueden los usuarios de la documentación modificar la URL base en documentos compartidos?
En la documentación publicada o en la documentación compartida rápidamente de Apidog, si desea que los usuarios de la documentación puedan establecer y modificar la URL base, puede lograrlo fácilmente mediante la configuración de variables. Los pasos específicos de operación son los siguientes:
1
Crear y referenciar variables
En el proyecto de Apidog, vaya a una página de "Entorno" determinada, haga clic en "Agregar variable" e introduzca el nombre de la variable (por ejemplo, "BaseURL"). En el cuadro de entrada de URL correspondiente a la "URL base" del entorno, utilice la referencia de variable (por ejemplo, {{BaseURL}}) para reemplazar la dirección URL específica. Esto asocia la URL base con la variable creada.
2
Seleccionar entorno
Elija el entorno correspondiente al publicar la documentación.
3
Acceder al documento
Después de que el documento se publique y se comparta con los usuarios, estos podrán ver el lugar donde se referencia la variable en el endpoint. Cuando el cursor pase sobre la referencia de la variable, se le indicará al usuario que establezca el valor de la variable.
4
Modificar el valor de la variable
Haga clic en la variable y la ventana de configuración de la variable aparecerá automáticamente. El usuario solo debe completar el valor real requerido.
Después de guardar, las rutas que se muestran en el documento y las peticiones reales aplicarán automáticamente el valor actualizado de la variable.
Este método permite a los usuarios personalizar la URL base para acceder a sus datos específicos.