如何在api-blueprint中指定对象类型的示例

时间:2016-12-16 09:31:07

标签: apiblueprint

是否可以在以下数据结构中为Baz类型指定'bar'的示例值?

# Data Structures
## Foo (object)
   + arg0 (number, required) - the arg0
   + arg1 (number, optional) - the arg1
   + arg2: a, b, c (enum, required) - the arg2

## Baz (object)
  + bar (Foo, required)

提前致谢

- 乌尔里希

1 个答案:

答案 0 :(得分:0)

您应该能够通过指定复杂对象的每个属性来提供示例,如下所示:

+ bar (Foo, required)
    + Sample
        + (object)
            + arg0: 1
            + arg1: 2