Gérer 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.

Jusqu'à son activation, elle est visible uniquement aux utilisateur·trices ayant accès à la définition de l'API, comme indiqué dans le bouton Live Documentation dans l'en-tête.

1. Allez à la page Settings.
   Vous pouvez accéder à cette page dans Edit (Édition) > Settings (Paramètres) ou en cliquant sur Settings (Paramètres) dans le panneau de gauche.
2. Passez le bouton Enabled de Off à On et saisissez une URL.

   

3. Choisissez le type de visibilité. Si vous sélectionnez Password protected, saisissez un mot de passe dans le champ correspondant.
4. Cliquez sur Save afin d'activer votre documentation en temps réel.

Résultats

Votre documentation en temps réel est disponible. Vous pouvez cliquer sur Open pour l'ouvrir dans un nouvel onglet.

Désactivez votre documentation et choisissez de conserver ou non son sous-domaine.

1. Ouvrez votre API et allez dans Settings.
2. Passez le bouton Enabled de On à Off.
3. Si vous souhaitez libérer le sous-domaine de la documentation, décochez la case Retain Live API documentation subdomain.
   Par défaut, Talend Cloud API Designer sauvegarde le sous-domaine 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.

   

4. Cliquez sur Save (Sauvegarder).