在API Blueprint文档中,我可以将模型与标题组合在一起吗?

时间:2013-12-24 21:24:23

标签: apiblueprint

“模型”工具似乎旨在减少重复 - 在指定资源上的各种方法的请求和响应时,将经常多次指定相同的主体。因此,可以定义“模型”,然后在各种请求和响应“有效负载”部分中“引用”它。

所以我已经定义了这样的模型:

### An Event

* Model (application/vnd.document+json)

            {
                "_type": "document",
                ...
            }     

然后我可以在不同的地方引用它:

* Response 200

    [An Event][]

效果很好;输出包括整个模型体代替交叉引用。

但是,我无法弄清楚如何将此引用与请求或响应头相结合。

我已尝试过各种格式:

* Request

    * Headers

            If-Match: some-etag-value

    * Body

            [An Event][]

* Request

    * Headers

            If-Match: some-etag-value

    [An Event][]

没有运气。

有没有办法做到这一点?

1 个答案:

答案 0 :(得分:2)

目前无法更改引用模型的有效负载。它都没有计划在任何API Blueprint Milestones中。

如果愿意,可以随意将其添加到里程碑并提出其语法。在此之前,请考虑与计划API Blueprint Object Traits的任何潜在协同作用。