如何覆盖MSON Sample值

时间:2017-02-01 17:49:23

标签: markdown apiblueprint mson aglio

如果我使用样本值定义资源类型,如何针对特定示例覆盖它们?

我试过这个,但渲染的输出会忽略Body并改为使用全局Sample。

### Read item [GET]
+ Response 200
    + Attributes (A, fixed-type)
    + Body

            { "name": "Hello", "bs": [{ "key": "value" }]}

# Data Structures
## A
+ name: foo(string, required)
+ bs (array[B], optional, fixed-type)
    + Sample
        + key: baz
        + key: bat
## B
+ key (string, optional)

奇怪的是,如果从架构中删除样本值,它会正确使用Body for Request但是对于Response,它将每个字符串参数都设为"Hello, world!",每个数字都为1等。

2 个答案:

答案 0 :(得分:1)

如果您使用aglio并且得到

  

字符串参数为"Hello, world!",每个数字为1

比使用DRAFTER_EXAMPLES环境变量: DRAFTER_EXAMPLES=true aglio -i apiary.apib

答案 1 :(得分:1)

我知道这是一个老话题,但是只是遇到了这个问题,想详细说明上述答案。为了使此工作正常进行,我必须在环境中设置DRAFTER_EXAMPLES,然后执行aglio命令。例如:

set DRAFTER_EXAMPLES=true

aglio -i apiary.apib -o output.html