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

Activer la documentation en temps réel pour votre API

Activez la documentation en temps réel pour générer un aperçu de la documentation de votre API.

Procédure

  1. Cliquez sur le bouton Settings (Paramètres).
  2. Dans la section LIVE DOCUMENTATION (DOCUMENTATION EN TEMPS RÉEL), activez l'option Enabled sur On.
  3. Saisissez un nom de sous-domaine pour votre documentation en temps réel.

    Exemple

    Exemple d'une définition de documentation en temps réel.
  4. Configurez la visibilité, Team (Équipe) dans cet exemple, puis cliquez sur Save (Sauvegarder).

Résultats

Une fois la documentation en temps réel activée, vous pouvez cliquer sur le lien Open (Ouvrir) qui s'affiche à droite du champ URL, pour voir la prévisualisation.

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