Accéder au contenu principal

Utiliser des exemples

Ajoutez des données d'exemple dans des champs d'exemple de votre API.

Dans Talend Cloud API Designer, vous pouvez ajouter des valeurs d'exemple pour différents éléments de votre API. Une fois que vous avez défini un exemple, il est utilisé lors d'appels d'API de votre mock.

Dans l'exemple suivant, un type de données a été créé à l'aide d'un exemple.

Capture d'écran du type de données Character généré depuis un exemple JSON.

Ce type de données est ensuite utilisé comme corps de réponse pour une opération.

Le type de données Character est retourné pour la méthode nommée Get a Star Wars character by ID.

Lors du test d'une opération dans Talend Cloud API Tester, l'exemple est retourné comme réponse.

Réponse avec un exemple de personnage. Ici, le personnage est Luke Skywalker.

Vous pouvez définir des exemples dans différentes parties de votre API. Certains peuvent écraser les autres lors d'appels de votre mock. Ici, l'exemple du type de données est utilisé mais vous pouvez également définir un exemple pour la réponse de l'opération.

Un nouvel exemple est défini pour la réponse. Ici, le personnage est Organa.

Lors du test de l'opération dans Talend Cloud API Tester, l'exemple fourni dans l'opération prend la préséance sur celui défini dans le type de données.

Le personnage de la réponse d'exemple est à présent Leia Organa.

Dans un type de données, vous pouvez définir un exemple pour l'objet entier, mais également pour les propriétés individuelles. Si vous utilisez les deux, l'exemple utilisé pour l'objet entier est retourné lors du test du mock.

Les exemples externes ne sont pas supportés.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – dites-nous comment nous améliorer !