Définir les informations générales de l'API - 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
Modifiez les informations générales de votre API et définissez les types de médias, les endpoints et les schémas de sécurité.

Procédure

  1. Accédez à la page des informations générales.
    Cette page s'ouvre automatiquement après la création de votre API. Vous pouvez également l'ouvrir en cliquant sur le nom de votre API, en haut du panneau de gauche.
  2. Cliquez sur l'icône représentant un crayon, à gauche de la section GENERAL pour modifier les champs Name, Version et Description de votre API.
    Vous pouvez également ajouter les éléments suivants.
  3. Modifiez la section MEDIA TYPES pour ajouter ou supprimer des types de médias.
    Les types de médias définis dans cette section sont globaux et appliqués à l'API entière. Ils peuvent également être définis au niveau des opérations.
  4. Ajoutez votre (vos) endpoint(s) dans la section ENDPOINTS.
    Les types de médias définis dans cette section sont globaux et appliqués à l'API entière. Une fois définis, vos endpoints s'affichent sous le nom de votre API en haut du panneau de gauche, avec l'endpoint de mock s'il est activé.

    Les URL relatives ne sont pas supportées.

    Remarque : S vous avez plusieurs endpoints, le premier de la liste est utilisé par défaut lorsque vous essayez votre API dans Talend Cloud API Tester. Vous pouvez déplacer un endpoint dans la liste en cliquant sur la barre à gauche de l'URL et en glissant vers le haut ou vers le bas.
  5. Définissez la sécurité de l'API dans les sections GLOBAL SECURITY et SECURITY SCHEMES.
    La sécurité définie dans cette section est globale et est appliquée à l'API entière. Elle peut également être définie au niveau des ressources et des opérations.
  6. Cliquez sur Save.