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

Activer la documentation d'API en temps réel

Générez un aperçu en temps réel de la documentation de votre API.

Procédure

  1. Ouvrez votre définition d'API dans Talend Cloud API Designer.
  2. Cliquez sur Settings en haut du panneau de gauche.
  3. Dans la section LIVE DOCUMENTATION, placez le bouton Enabled sur On.
  4. Saisissez une URL pour votre documentation.
    L'URL de la documentation doit être unique. Vous pouvez saisir moviecatalog-<your company name> par exemple.
  5. Sélectionnez la visibilité (Visibility) de la documentation, Public par exemple.
    Section LIVE DOCUMENTATION (Documentation en temps réel).
  6. Cliquez sur Save (Sauvegarder).

Résultats

Votre documentation en temps réel est à présent activée et disponible pour toute personne ayant l'URL définie.

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.