2014-02-18 40 views
3

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

+0

你指的是资源属性 - 的性质资源还是特定的HTTP消息体(请求/响应)属性? – Zdenek

+0

我正在寻找为每个资源属性指定数据类型。我还想提供更多信息。想象一下名为“ip”的属性,它将是一个字符串,我也想说明它可以是ipv4或ipv6地址。 所有这些都很容易做到降价,但我想知道是否有一个约定,可以增加更多的价值。日Thnx。 – jevonearth

回答

2

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

但是我觉得真正的解决方案是什么,未来的API蓝图的概念 - Resource Blueprint建议在语义数据定义(资源)。请参阅example resource blueprint

因此,尽管没有对以前的实现,如果你正在寻找一个约定,我建议考虑一个在资源蓝图如提出:

​​
+0

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

相关问题