Gestionar la documentación en vivo | Qlik Cloud Ayuda
Saltar al contenido principal Saltar al contenido complementario

Gestionar la documentación en vivo

Habilitación de la documentación en vivo

Para compartir la documentación de su API con personas que no forman parte de su equipo, debe habilitar la función de documentación en vivo.

Hasta que se habilite, solo se puede ver como una vista previa para los usuarios que tienen acceso a la definición de la API.

  1. Vaya a la página de Configuración de su API haciendo clic en Editar > Abrir configuración de la API.
  2. Cambie el estado del botón Activado de Desactivado a Activado e introduzca una URL.
    Configuración de la documentación en vivo.
  3. Elija la visibilidad. Si selecciona Protegido con contraseña, introduzca una contraseña en el campo correspondiente.
  4. Haga clic en Guardar para habilitar su Documentación en vivo.

Su Documentación en vivo ya está disponible. Puede hacer clic en Abrir para abrirla en una nueva pestaña.

Deshabilitar la Documentación en vivo

Deshabilite su documentación y seleccione si desea conservar su subdominio.

  1. Abra su API y vaya a Configuración de API abierta.
  2. Cambie el botón Habilitado de Activado a Desactivado.
  3. Si desea liberar el subdominio de la documentación, borre la casilla de verificación Mantener subdominio de documentación de API en vivo.
    De forma predeterminada, API Designer guarda el subdominio que definió al habilitar la Documentación en vivo. Esto le permite mantener la misma URL si la habilita de nuevo más tarde. Si desea utilizar este subdominio para una API diferente, primero debe liberarlo.
    Configuración de la documentación en vivo.
  4. Haga clic en Guardar.
Su documentación en vivo está deshabilitada. Si conservó el subdominio, puede volver a habilitarlo en cualquier momento. Si no, el subdominio puede ser utilizado por otra API y tendrá que introducir un subdominio si desea habilitar esta documentación de nuevo.

¿Esta página le ha sido útil?

Si encuentra algún problema con esta página o su contenido (errores tipográficos, pasos que faltan o errores técnicos), no dude en ponerse en contacto con nosotros.