Accéder au contenu principal Passer au contenu complémentaire

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.

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.

Bouton Live Documentation (Documentation en temps réel) dans l'en-tête.

Procédure

  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.
    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.

Capture d'écran de la documentation en temps réel de l'API Petstore.

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 – dites-nous comment nous améliorer !

Laissez vos commentaires ici