Api-blueprint: Problema com valores de atributo

Criado em 29 abr. 2015 · 6Comentários · Fonte: apiaryio/api-blueprint

Estou tentando definir um atributo com um valor que é um GUID, mas não consigo encontrar uma maneira de expressar isso adequadamente:

Atributos (objeto)
- uuid: 08ff7052-2e95-11e3-a1fc-000c294eede0 (guid) - ID exclusivo
- data: 2014-07-14T12: 03: 20z (data) - Uma data

Ao fazer o acima, o analisador parece cortar a definição no primeiro "-", o que significa que a primeira parte da string é considerada o valor de exemplo (por exemplo, "08ff7052") e a segunda parte é considerada parte de a descrição (por exemplo, "2e95-11e3-a1fc-000c294eede0 (guid) - ID exclusivo")

Provavelmente estou fazendo algo errado ... você pode me indicar a direção certa?

Question

Fonte

jmdacruz

Comentários muito úteis

Quando um literal contém caracteres reservados, como - ele precisa ser encapsulado em crases. Veja os caracteres e palavras-chave reservados .

Deve ser parecido com o seguinte:

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

kylef em 29 abr. 2015

👍3

Todos 6 comentários

Quando um literal contém caracteres reservados, como - ele precisa ser encapsulado em crases. Veja os caracteres e palavras-chave reservados .

Deve ser parecido com o seguinte:

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

kylef em 29 abr. 2015

👍3

Obrigado, isso fez parte do truque ... mas também parece que não consigo definir tipos de dados personalizados (por exemplo, "guid" ou "data"), pois também recebo um erro ao fazer isso.

jmdacruz em 29 abr. 2015

@jmdacruz Você precisaria declará-los na seção Data Structures . Por exemplo:

+ 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 em 29 abr. 2015

👍2

Doh! obrigado, eu tinha sentido falta disso. Existe uma maneira de anexar expressões regulares a essas estruturas de dados definidas pelo usuário? Se não, pode ser bom ter.

jmdacruz em 29 abr. 2015

@jmdacruz Você pode fornecer uma seção de esquema personalizada e usar as expressões regulares do esquema JSON . No futuro, consideramos ter as validações certas nas estruturas de dados definidas pelo usuário.