Utiliser des exemples

Ajoutez des échantillons de données dans les champs d'exemple tout au long de votre API.

Dans API Designer, vous pouvez ajouter des exemples de valeur pour divers éléments de votre API. Une fois que vous avez défini un exemple, il est utilisé lors des appels d'API auprès 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.

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.

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 – faites-le-nous savoir.

Laissez vos commentaires ici