Activer la documentation en temps réel pour votre API - Cloud

Guide de prise en main de Talend Cloud API Designer

Version
Cloud
Language
Français (France)
Product
Talend Cloud
Module
Talend API Designer
Content
Création et développement > Création d'APIs
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

  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.