Gérer la documentation en temps réel
Activer la documentation en temps réel
Pour partager votre documentation API en dehors de votre équipe, vous devez activer la fonctionnalité de documentation en temps réel.
Tant qu'elle n'est pas activée, elle est visible uniquement sous forme d'aperçu aux utilisateur·trices qui ont accès à la définition d'API.
- Passez le bouton Enabled (Activé) de Off (Inactif) à On (Actif) et saisissez une URL.
Votre documentation en temps réel est disponible. Vous pouvez cliquer sur Open (Ouvrir) pour l'ouvrir dans un nouvel onglet.
Désactiver la documentation en temps réel
Désactivez votre documentation et choisissez de conserver ou non son sous-domaine.
- Si vous souhaitez libérer le sous-domaine de la documentation, décochez la case Retain Live API documentation subdomain (Conserver le sous-domaine de la documentation d'API en temps réel). Par défaut, API Designer enregistre le sous-domaine que vous avez défini lors de l'activation de la documentation en temps réel. Cela vous permet de conserver la même URL, même si vous l'activez à nouveau plus tard. Si vous souhaitez utiliser ce sous-domaine pour une API différente, vous devez d'abord le libérer.
Votre documentation en temps réel est désactivée Si vous avez conservé le sous-domaine, vous pouvez l'activer à nouveau à tout moment. Sinon, le sous-domaine peut être utilisé par une autre API et vous devrez saisir à nouveau un sous-domaine si vous souhaitez activer cette documentation à nouveau.