3

apiary.io 以点的形式列出资源属性。是否有特定的约定来显示这些属性是什么数据类型,或者满足数据指定格式?

4

1 回答 1

2

目前在 API 蓝图中没有讨论资源属性的约定。即将到来的是计划中 的 Message-body Attributes Description

但我觉得真正的解决方案是未来 API 蓝图的概念——资源蓝图在(资源的)语义数据定义下提出的概念。请参阅示例资源蓝图

因此,虽然前面没有实现,但如果您正在寻找一个约定,我建议您考虑资源蓝图中提出的约定,例如:

# Resource [/resource]

## Attributes

+ ip (string) ... ipv4 or ipv6 address associated with the resource
+ some-other-attribute (number, optional, `42`) ... a number of something
于 2014-02-19T10:41:54.753 回答