Utiliser les attributs des types de données
Les tableaux suivants décrivent les attributs pouvant être définis pour les différents types de données.
Attributs généraux
Ces attributs sont disponibles pour tous les types de données.
Champ | Description | Élément correspondant en OAS/Swagger et RAML |
---|---|---|
Name (Nom) |
Nom du type de données ou de la propriété. |
Élément racine du type de données ou de la définition de la propriété. |
Description |
Description de la propriété. |
description |
Requise |
Booléen, définit si une propriété est requise ou facultative. |
|
Restrictions |
Définit si la propriété est disponible dans la requête, dans la réponse ou dans les deux. |
|
Exemples |
Valeurs d'exemple pour la propriété. Elles peuvent être retournées à l'aide d'un mock d'API. |
|
Attributs d'objet
Champ | Description | Élément correspondant en OAS/Swagger et RAML |
---|---|---|
Additional Properties (Propriétés supplémentaires) |
Booléen, définit si l'objet accepte les propriétés non incluses dans la définition du type de données. Ceci est activé par défaut. |
additionalProperties |
Attributs de tableaux
Champ | Description | Élément correspondant en OAS/Swagger et RAML |
---|---|---|
Min items et Max items |
Nombre minimal et nombre maximal d'éléments dans un tableau. |
minItems et maxItems |
Unique items |
Booléen, définit si chaque élément dans un tableau doit être unique. |
|
Attributs de chaînes de caractères
Champ | Description | Élément correspondant en OAS/Swagger et RAML |
---|---|---|
Enum |
Valeurs possibles pour la propriété. |
enum |
Min length et Max length |
Nombre minimal et nombre maximal d'octets dans la valeur. |
minLength et maxLength |
Pattern (Modèle) |
Expression régulière à laquelle la valeur doit correspondre. |
pattern |
Default |
Valeur à utiliser si aucune valeur n'est fournie. |
Default |
Attributs de nombres et d'entiers
Champ | Description | Élément correspondant en OAS/Swagger et RAML |
---|---|---|
Enum |
Valeurs possibles pour la propriété. |
enum |
Format |
Format à utiliser pour un nombre ou un entier. |
format |
Minimum et Maximum |
Valeur minimale et valeur maximale d'un nombre ou d'un entier. |
minimum et maximum |
Default |
Valeur à utiliser si aucune valeur n'est fournie. |
Default |
Attributs de date et heure
Champ | Description | Élément correspondant en OAS/Swagger et RAML |
---|---|---|
Enum |
Valeurs possibles pour la propriété. |
enum |
Default |
Valeur à utiliser si aucune valeur n'est fournie. |
Default |
Attributs d'horodatage (Datetime)
Champ | Description | Élément correspondant en OAS/Swagger et RAML |
---|---|---|
Enum |
Valeurs possibles pour la propriété. |
enum |
Format |
Format à utiliser pour un horodatage. |
|
Attributs de fichiers
Champ | Description | Élément correspondant en OAS/Swagger et RAML |
---|---|---|
Min length et Max length |
Nombre minimal et nombre maximal d'octets dans la valeur. |
minLength et maxLength |
File types |
Type de fichier à utiliser, au format */*. Par exemple : image/png |
|