Gestione della Live Documentation | Guida di Qlik Cloud
Vai al contenuto principale Passa a contenuto complementare

Gestione della Live Documentation

Abilitazione della Live Documentation

Per condividere la documentazione dell'API con persone che non fanno parte del team, è necessario abilitare la funzionalità Live Documentation.

Finché non viene abilitata, è visualizzabile solo come anteprima per gli utenti che hanno accesso alla definizione dell'API.

  1. Andare alla pagina Impostazioni dell'API facendo clic su Modifica > Apri impostazioni API.
  2. Spostare il pulsante Abilitato da Off a On e inserire un URL.
    Configurazione della Live Documentation.
  3. Scegliere la visibilità. Se si seleziona Protetto da password, inserire una password nel campo corrispondente.
  4. Fare clic su Salva per abilitare la Live Documentation.

La Live Documentation è ora disponibile. È possibile fare clic su Apri per aprirla in una nuova scheda.

Disabilitazione della Live Documentation

Disabilitare la documentazione e selezionare se si desidera mantenere il relativo sottodominio.

  1. Aprire l'API e andare su Apri impostazioni API.
  2. Spostare il pulsante Abilitato da On a Off.
  3. Se si desidera rilasciare il sottodominio della documentazione, cancella la casella di controllo Mantieni il sottodominio della documentazione Live API.
    Per impostazione predefinita, API Designer salva il sottodominio definito quando è stata abilitata la Live Documentation. Ciò consente di mantenere lo stesso URL se la si abilita di nuovo in seguito. Se si desidera utilizzare questo sottodominio per un'API diversa, è necessario prima rilasciarlo.
    Configurazione della Live Documentation.
  4. Fare clic su Salva.
La Live Documentation è disabilitata. Se è stato mantenuto il sottodominio, è possibile abilitarla di nuovo in qualsiasi momento. In caso contrario, il sottodominio può essere utilizzato da un'altra API e sarà necessario inserire un sottodominio se si desidera abilitare nuovamente questa documentazione.

Hai trovato utile questa pagina?

Se riscontri problemi con questa pagina o con il suo contenuto – un errore di battitura, un passaggio mancante o un errore tecnico – ti pregiamo di farcelo sapere!