Api-blueprint: Problème avec les valeurs d'attribut

Créé le 29 avr. 2015 · 6Commentaires · Source: apiaryio/api-blueprint

J'essaie de définir un attribut avec une valeur qui est un GUID, mais je ne semble pas trouver le moyen d'exprimer correctement ceci :

Attributs (objet)
- uuid : 08ff7052-2e95-11e3-a1fc-000c294eede0 (guid) - ID unique
- date: 2014-07-14T12:03:20z (date) - Une date

En faisant ce qui précède, l'analyseur semble couper la définition sur le premier "-", ce qui signifie que la première partie de la chaîne est considérée comme la valeur d'exemple (par exemple, "08ff7052") et la deuxième partie est considérée comme faisant partie de la description (par exemple, "2e95-11e3-a1fc-000c294eede0 (guid) - ID unique")

Je fais probablement quelque chose de mal... pouvez-vous m'indiquer la bonne direction ?

Question

Source

jmdacruz

Commentaire le plus utile

Lorsqu'un littéral contient des caractères réservés tels que - il doit être entouré de backticks. Voir les caractères réservés et les mots-clés .

Il devrait ressembler à ceci :

+ Attributes (object)
    + uuid: `08ff7052-2e95-11e3-a1fc-000c294eede0` (guid) - Unique ID
    + date: `2014-07-14T12:03:20z` (date) - A date

kylef le 29 avr. 2015

👍3

Tous les 6 commentaires

Lorsqu'un littéral contient des caractères réservés tels que - il doit être entouré de backticks. Voir les caractères réservés et les mots-clés .

Il devrait ressembler à ceci :

+ Attributes (object)
    + uuid: `08ff7052-2e95-11e3-a1fc-000c294eede0` (guid) - Unique ID
    + date: `2014-07-14T12:03:20z` (date) - A date

kylef le 29 avr. 2015

👍3

Merci, cela a fait une partie de l'astuce... mais il semble également que je ne puisse pas définir de types de données personnalisés (par exemple, "guid" ou "date"), car j'obtiens également une erreur en faisant cela.

jmdacruz le 29 avr. 2015

@jmdacruz Vous devrez les déclarer dans la section Data Structures . Tels que les suivants :

+ Attributes (object)
    + uuid: `08ff7052-2e95-11e3-a1fc-000c294eede0` (guid) - Unique ID
    + date: `2014-07-14T12:03:20z` (date) - A date

# Data Structures
## guid (string)
## date (string)

kylef le 29 avr. 2015

👍2

Oh ! merci, j'avais raté ça. Existe-t-il un moyen d'attacher des expressions régulières à ces structures de données définies par l'utilisateur ? Sinon, cela pourrait être un bon à avoir.

jmdacruz le 29 avr. 2015

@jmdacruz Vous pouvez fournir une section Schema personnalisée et utiliser les expressions régulières de JSON Schema . À l'avenir, nous envisageons d'avoir des validations directement dans les structures de données définies par l'utilisateur.