Accéder au contenu principal Passer au contenu complémentaire
Ressources Qlik
Chargement de la recherche avec SearchUnify Si vous avez besoin d'aide avec votre produit, contactez le Support Qlik.
Qlik Customer Portal
Chargement de la recherche avec SearchUnify Si vous avez besoin d'aide avec votre produit, contactez le Support Qlik.
Qlik Customer Portal

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.

Procédure

  1. Accédez à la page Settings (Paramètres) de votre API en cliquant sur Edit (Modifier) > Open API settings (Ouvrir les paramètres d'API).
  2. Passez le bouton Enabled de Off à On et saisissez une URL.
    Configuration de la documentation en temps réel.
  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ésactiver la documentation en temps réel

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

Procédure

  1. Ouvrez votre API et accédez à Open API settings (Ouvrir les paramètres d'API).
  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.
    Configuration de la documentation en temps réel.
  4. Cliquez sur Save (Sauvegarder).

Résultats

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.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.

Laissez vos commentaires ici