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

【问题标题】：What is the convention to specify data types of attributes in apiary.io markdown?在 apiary.io markdown 中指定属性数据类型的约定是什么？
【发布时间】：2014-02-18 20:47:34
【问题描述】：

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

【问题讨论】：

您指的是资源属性——资源的属性还是特定的 HTTP 消息体（请求/响应）属性？
我希望说明每个资源属性的数据类型。我还想提供更多信息。想象一个名为“ip”的属性，它是一个字符串，我还想说明它可以是 ipv4 或 ipv6 地址。所有这些在降价中都很容易做到，但我想知道是否有一个约定，这可能会增加更多的价值。谢谢。

标签： apiblueprint apiary.io apiary

【解决方案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

【讨论】：

谢谢，您回答了我关于资源属性数据类型建模的约定/语法的具体问题。您还回答了我没有问的问题，即如何对状态机进行建模。这是，或者我应该说将是很棒。我很高兴看到状态机的建模。我期待添加资源蓝图支持。希望很快。