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

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

所以我定义了一个这样的模型:

### 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][]

没有运气.

有没有办法做到这一点?

最佳答案 目前无法更改引用模型的有效负载.在
API Blueprint Milestones的任何一个都没有计划.

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

    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞