Un type de données est une description des données échangées sur le réseau. Il peut être réutilisé dans toute la version de l'API.
Procédure
-
Cliquez sur le bouton + dans le coin supérieur droit du panneau de gauche.
Conseil : Si vous souhaitez créer un type de données directement à partir d'une section créée antérieurement, il vous suffit de cliquer sur le bouton + à droite du nom de la section.
-
Cliquez sur Data type.
-
Saisissez un nom pour votre type de données dans Name, comme Contact par exemple, puis rédigez une description dans Description si nécessaire.
- Facultatif :
Sélectionnez la Section dans laquelle vous souhaitez inclure le type de données.
-
Si vous disposez déjà d'un exemple JSON de votre type de données, vous pouvez l'utiliser pour générer vos propriétés en cliquant sur Generate from JSON example.
-
Saisissez votre exemple et cliquez sur Generate.
Exemple
Toutes les propriétés dans l'exemple sont créées dans votre type de données.
-
Pour ajouter des propriétés manuellement, sélectionnez un Type.
Le type est
object par défaut, mais vous pouvez cliquer pour afficher tous les types disponibles.
-
Cliquez sur Add property pour créer une nouvelle propriété et définissez les champs Name et Type.
- Facultatif :
Placez le bouton Required sur Yes si la propriété est requise.
-
Ajoutez une Description si nécessaire et cliquez sur more attributes pour ajouter plus d'informations à votre type de données.
Exemple
-
Ajoutez autant de propriétés que nécessaire, puis cliquez sur Save.
Toutes les propriétés dans l'exemple sont créées dans votre type de données.
