2017-03-16 83 views
0

在我的蓝图,我定义的数据结构,并尝试使用它像在文档的末尾,以便API蓝图:语义问题

+ Attributes 

    + error: (Error Details, required) 

数据结构定义“没有指定值(S)”:

# Data Structures 

## Error Details 
+ code : 1234 (number, required) - see list of error codes 
+ message: User not found (string, required) - a human-readable error message 

得到的样本响应身体看起来就像是预期,但对apiary.io验证显示了每个地方我使用这样结构的地方语义问题,他说“没有规定值(S)”。

我做错了什么或与apiary.io解析器有问题吗?

回答

0

属性部分也可以定义为+ Attributes <Type Definition>specification),所以定义+ Attributes (Error Details, required)应该修复给定的语义问题。

编辑:

你必须忽略属性的名称和类型之间的冒号,如果没有定义例子值:

+ Attributes 

    + error (Error Details, required) 

错过了之前,对不起。

+0

不幸的是,这只会在这个非常具体的例子。例如,如果属性类型是枚举,则不会。我想避免在多个地方重复枚举定义,但指定一个样本值将在apiary.io的允许值列表中重复该值。 –

1

我现在有与ApiBlueprint相同的问题,这是解决我的问题。 建设没有任何错误或警告。

省略分号和单独对象的定义和类型,如owner

## Company (object) 
- name: Company name (string) 
- owner (OwnerResponse) (object) 

希望它能帮助任何人。