Publication de votre documentation - Cloud

Guide d'utilisation de Talend Cloud API Designer

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
task
Création et développement > Création d'APIs
EnrichPlatform
Talend API Designer

Pour partager votre documentation API en dehors de votre équipe, vous devez la publier.

Jusqu'à la publication de la documentation de votre API, elle est disponible uniquement en tant qu'aperçu, comme indiqué sur le bouton Documentation dans l'en-tête.

Procédure

  1. Allez à la page Settings.
    Vous pouvez accéder à cette page dans API > Settings ou en cliquant sur Settings dans le panneau de gauche.
  2. Passez le bouton Published de Off à On et saisissez une URL.
  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 de publier votre documentation.

Résultats

La documentation de votre API est publiée. Vous pouvez cliquer sur Open pour l'ouvrir dans un nouvel onglet.