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

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

最佳答案

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

但我觉得真正的解决方案是 future 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

关于apiblueprint - 在 apiary.io markdown 中指定属性数据类型的约定是什么？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/21864954/