定义有效属性值的API蓝图MSON？

Question

考虑一下这段摘录自https://github.com/apiaryio/mson#example-1 ..。

示例1

一个简单的object结构及其相关的JSON表达式。

MSON

- id: 1 - name: A green door - price: 12.50 - tags: home, green

假设我想为属性定义有效值。考虑使用像Dredd这样的工具进行API测试的上下文。为了获得这个资源，我们可能需要定义预期的/有效的name值，否则可能会出现故障，这个测试步骤应该会失败。

和/或，如果创建/更新这种类型的资源，我们可能需要定义哪些name值是有效/接受的。这目前可以在MSON中定义吗？

(我相信这可以在JSON模式中完成，这使我对MSON支持充满希望。)

下面是一个API蓝图资源示例，说明如何使用.

# Thing ID [/api/thing/id]

# List Thing ID attributes [GET]

    + Response 200

    + Attributes
        + href (string)
        + make (string)
        + model (string)
        + version (string)

    + Body

            {"href":"/api/thing/id","make":"BrandX","model":"SuperThingy","version":"10.1"}

在上面的示例中，model属性有3个已知/接受/有效值：CoolThingy、AwesomeThingy和MLGThingy

我们能用MSON来表示这个资源吗，这样.

• API文档使用者可以很容易地知道预期的model值吗？
• Dredd在响应到此资源的响应中处理并传递/失败model值？

Answer 1

在MSON中，您可以使用enum，参见下面的示例。

• name (enumstring)
  • joe (默认)
  • ben
  • mark

​