apiblueprint - 在 API 蓝图文档中,我可以将模型与标题结合使用吗?

标签 apiblueprint

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

所以我定义了一个模型:

### An Event

* Model (application/vnd.document+json)

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

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

    [An Event][]

效果很好;输出包括整个模型主体,而不是交叉引用。

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

我已经尝试了这些方面的各种格式:
* 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 .

关于apiblueprint - 在 API 蓝图文档中,我可以将模型与标题结合使用吗?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/20766901/

相关文章:

JSON 到蓝图/MSON

parameters - Apiary:有没有办法定义参数的选项?

jsonschema - api-blueprint 未正确显示嵌套 "One of"属性

用于从 Swagger、RAML 或 API 蓝图生成 HTML 的 Java 或 JavaScript 库

apiblueprint - 如何在 API 蓝图中定义枚举数组

apiblueprint - 如何使用 apiary 记录多部分请求?

apiblueprint - 在 Apiary 中表示输入参数是日期/时间的正确格式是什么?

json - Api 蓝图和长时间运行的作业

google-app-engine - 从 Java Cloud Endpoint 生成 API 文档