Créer une opération - Cloud

Guide d'utilisation de Talend Cloud API Designer

Version
Cloud
Language
Français
Product
Talend Cloud
Module
Talend API Designer
Content
Création et développement > Création d'APIs
Last publication date
2024-03-13
Une opération est l'action qui peut être effectuée sur vos ressources.

Procédure

  1. Cliquez sur le bouton + dans le coin supérieur droit du panneau de gauche.
    Conseil : Si vous souhaitez créer votre opération directement dans une section précédemment créée, vous pouvez le faire en cliquant sur le bouton + à droite du nom de la section. Si vous avez déjà créé une ressource, vous pouvez cliquer sur le bouton + à droite du chemin de la ressource afin de créer une opération pour cette ressource.
  2. Cliquez sur Operation, ou cliquez sur le type d'opération, par exemple GET si vous la créez dans une ressource existante.
    Si vous créez une opération dans une ressource existante, la méthode et le chemin de l'opération sont automatiquement renseignés.
  3. Saisissez un nom, dans le champ Name, pour votre opération, Get list of contacts par exemple.
  4. Sélectionnez la méthode dans la liste Method et saisissez un chemin dans le champ Path, ainsi qu'une Description si nécessaire.
    Si vous saisissez un chemin ne correspondant à aucune ressource existante, une nouvelle ressource est créée.
    Exemple de création d'une méthode GET appelée "Get list of contacts" avec le chemin /contacts/.
  5. Renseignez les champs Tags et Id si nécessaire.
  6. Si vous souhaitez ajouter un schéma de sécurité différent de celui de l'API complète, cliquez sur l'icône représentant un crayon, à droite de SECURITY et sélectionnez Customize security for this resource.
  7. Sélectionnez votre (vos) schéma(s) de sécurité.
    Remarque : Les schémas de sécurité sont définis dans la section SECURITY de votre API.
  8. Ajoutez des paramètres REQUEST et RESPONSES si nécessaire.
    Les corps de requêtes réutilisables ne sont pas supportés.
    Remarque : Les noms d'en-tête qui contiennent des tirets comme Content-Type ou Access-Key peuvent provoquer des erreurs dans le Studio Talend. Évitez d'utiliser des tirets si vous souhaitez importer votre définition d'API et l'utiliser dans un Job ou une Route.
  9. Cliquez sur Save (Enregistrer).