Définir des réponses - 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
Définissez une ou plusieurs réponses pour votre opération.

Procédure

  1. Pour ajouter des réponses à votre opération, cliquez sur le nom de l'opération, faites défiler jusqu'à la section RESPONSES et cliquez sur Add.
  2. Sélectionnez un code de statut et ajoutez une description si nécessaire.
    Vous pouvez sélectionner :
    • un code de statut spécifique comme 200 ;
    • une plage de réponses comme 2XX ;
    • une réponse par défaut Default .
  3. Pour ajouter un en-tête, cliquez sur Add (Ajouter), à droite de HEADERS (EN-TÊTES).
  4. Saisissez un nom dans le champ Name.
    Commencez à saisir un nom pour voir une liste déroulante d'en-têtes.

    Exemple

    Capture d'écran de la liste des en-têtes commençant par "Content".
  5. Sélectionnez un Type.
    Vous pouvez utiliser un type de données réutilisable.
  6. Cliquez sur more attributes pour ajouter plus d'informations à votre réponse.
  7. Si vous devez définir plus d'en-têtes, cliquez sur Add a header et répétez les étapes précédentes autant de fois que nécessaire.
  8. Pour définir un corps, cliquez sur Add à droite de BODY.
    Lier des valeurs de réponses à d'autres opérations n'est pas supporté.
  9. Cliquez sur le champ Media Types pour ajouter des types de média, si nécessaire.
    Vous pouvez ajouter autant de types de média que nécessaire.
  10. Saisissez une Description si nécessaire.
  11. Sélectionnez un Type et ajoutez les propriétés correspondantes.
    Vous pouvez utiliser un type de données réutilisable ou créer un nouveau type de données. Cliquez sur Extract data type si vous souhaitez sauvegarder le type de données créé dans votre API et le réutiliser.
    Conseil : Si vous ajoutez une valeur pour votre en-tête dans Examples, Enum ou Default, cette valeur sera retournée lors du test de votre mock dans Talend Cloud API Tester.

    Exemple

    Capture d'écran d'un en-tête Content-Type ayant un type Film media.
  12. Cliquez sur Add à droite de BODY afin de définir un nouveau corps avec différents types de média, si nécessaire.
  13. Cliquez sur Add à droite de RESPONSES pour ajouter une réponse, si besoin.
    Vous pouvez ajouter autant de réponses que nécessaire, tant que chaque code de statut est unique.
  14. Cliquez sur Save.