在apiary.io markdown中指定属性数据类型的约定是什么？

Question

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

Answer 1

目前还没有在API蓝图中讨论资源属性的惯例。接近的是计划 Message-body Attributes Description。

但我觉得真正的解决方案是未来API蓝图的概念 - Resource Blueprint在语义数据定义（资源的）下提出了什么。请参阅example resource blueprint。

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

# Resource [/resource]

## Attributes

+ ip (string) ... ipv4 or ipv6 address associated with the resource
+ some-other-attribute (number, optional, `42`) ... a number of something