问题标签 [apiary.io]

从 Apiary 开始，我目前正在为我们的项目指定 API。我能够定义 API 的定义并且定义参数效果很好。

现在，我还想将 HTTP 标头中传递的值添加到我的文档中（例如分页、API 的版本号……）

浏览文档时，我发现可以在有效负载块或请求块中添加标头，但我希望它们显示在文档中。

这可能吗？实现这一目标的最佳方法是什么？

我有一张桌子：

我有什么办法可以将多行代码块插入到生成的表格单元格中？

我想记录一个多部分请求，如下所示：

重现相同请求的 Acurl将类似于：

这个

生成    

现在这个：

生成    

为什么单个资源不是 Apiary 目录的一部分？

我在 Apiary 中定义了一个 API 合同，并且我正在使用资源模型语法来启用有效负载的重用。

Apiary 呈现的文档仅显示模型名称（例如，响应 200 返回一个 [Foo][]） - 没有任何关于 Foo 是什么的进一步详细信息，或任何查看 Foo 模型中属性的链接。

给定一个模型，我如何在渲染的文档中查看它的属性？

更新
合同的相关部分如下：

我想为 Apiary 参数定义选项，我目前在描述中列出它们：

• 测量= m（可选，字符串，m）...测量例如m =米，km =公里，yd =码，mi =英里

我的 API 返回完整的主机 URL，在 Apiary 中，每个用户都有自己的模拟服务器私有 URL。

有没有办法在响应正文中使用这个 URL？

现在我在响应正文中使用我自己的 URL。

返回图像 / PNG 的 APIary 调用的 Dredd 测试失败。是否可以不检查返回图像的内容，而只是检查有一个不为空的图像作为响应？

这是我的测试的输出：

我们正在构建的 API 允许用户提供不同的请求主体。从我目前所见/发现的情况来看，每个动作/资源只能提供一个请求。是否可以指定不同的请求主体？

我试过这样：

并且还喜欢：

apiary向我展示了如何向参数添加描述。但是，我需要的是对值进行描述。

例如 /users{?skills}。这个参数我有我自己的技能代码

'1' 表示会说英语

'2' 表示会游泳

'3' 表示可以开车

在参数描述之后添加它们是一种方法。如果我有技能代码的音调怎么办？而且这种方法的格式很难看。我怎样才能实现它？