Gestione della documentazione live
Ultimo aggiornamento: 20/10/2026Abilitazione della documentazione live
Per condividere la documentazione della tua API con persone che non fanno parte del tuo team, è necessario abilitare la funzionalità Live Documentation.
Finché non viene abilitato, è visualizzabile solo come anteprima per gli utenti che hanno accesso alla definizione dell'API.
- Sposta il pulsante Abilitato da Disattivato
ad Attivato e inserisci un URL.
La tua Live Documentation è ora disponibile. È possibile fare clic su Apri per aprirlo in una nuova scheda.
Disattivazione della Live Documentation
Disabilita la documentazione e seleziona se desideri mantenere il relativo sottodominio.
- Se desideri rilasciare il sottodominio della documentazione, cancella la casella di controllo Mantieni il sottodominio della documentazione API live.
Per impostazione predefinita, API Contracts salva il sottodominio definito quando hai abilitato la Live Documentation. Questo consente di mantenere lo stesso URL se lo riattivi in seguito. Se desideri utilizzare questo sottodominio per un'API diversa, devi prima rilasciarlo.
La tua Live Documentation è disabilitata. Se hai mantenuto il sottodominio, puoi riattivarlo
in qualsiasi momento. In caso contrario, il sottodominio potrà essere utilizzato da un'altra API e dovrai
inserire un sottodominio se desideri abilitare nuovamente questa documentazione.