问题标签 [apiary]

我想记录实际的 JSON 字段本身所代表的内容。

我已经记录了 GET 语句和参数，但这并没有提供给用户的完整文档。

因此，在下面的示例中，我将如何添加关于“OtherFields”的评论。这支持吗？或者我是否需要在其他地方制作配套文件。

我想要的是更改与 API Doc 关联的主要电子邮件，因此当我与其他人共享该文档时，他们会看到该新电子邮件而不是我的电子邮件。那封新电子邮件有一个 apiary.io，这就是我谈论所有权转移的原因。

apiary.io 以点的形式列出资源属性。是否有特定的约定来显示这些属性是什么数据类型，或者满足数据指定格式？

我安装了dredd - API Blueprint Testing Tool并尝试针对实现测试我们的 APIary API。

在蓝图中，我只有一个在 somehost 上正确实现的资源......但测试失败:(

测试命令： dredd apiary.apib http://somehost.de:8443/imp-endpoint

输出： Info: Beginning Dredd testing... undefined

我还尝试使用更多选项来获取更多未定义的信息。例如-l verbose和其他一些选项。但我没有得到更多关于失败的信息:(

有没有人有这方面的经验？谢谢！！！:)

我想知道我应该如何使用dredd测试 rails api ，特别是 show 和 index 操作（/post{id}和/post）

1. 我应该在运行dredd之前用记录填充我的数据库吗，我的意思是使用 id: 1 等创建记录帖子？
2. dredd 是否总是试图获取 id: 1 ( /post/1 ) 的对象？

我找到了示例项目https://github.com/theodorton/dredd-test-rails但在 apib 文件https://github.com/theodorton/dredd-test-rails/blob/中只描述了一种方法（帖子）主/apiary.apib

我正在尝试使用用蓝图编写的文档检查我的 api 实现。我预计当从服务器返回的 json 与文档中指定的不同时，dredd 会失败。为了检查这一点，我复制了 dredd-example。首先，我使用原始 apib 文件运行了 dredd，以确保一切都是绿色的。然后我修改了文档中的响应，并期望 dredd 向我显示一些红色......但它没有......看起来工具只检查响应标头而不是响应正文。这是控制台的输出：

我可以使用 dredd 检查响应正文吗？我该怎么做？

嗨，我正在使用 Apiary 来维护我的 REST API 的文档，因为我们的代码库正在增长，我们的 API 文档越来越大。将我们所有的 API 放在一个蓝图文件中变得非常困难，有什么方法可以正确地将它们组织成多个文件并在 apiary 中显示它们。

给定一些 API 文档docs.someurl.apiary.io（如http://docs.themoviedb.apiary.io），有没有办法用类似的东西来查看非格式化的源 api 蓝图降价source.themoviedb.apiary.io？

我认为对于像我这样的初学者来说查阅原始数据可能会很有用。

我正在记录一个 API，我有 2 个非常相似的响应。

其中之一是调用 /resource/{id}。此响应返回一个资源模型。

另一个调用是 /resource/search{?name,category} ，它返回资源列表，因此我需要返回资源模型的数组。

我找不到我能不能做到这一点。在蓝图文档中有关于 Gists 的类似内容。但是有两个模型 Gist 和 Gist Collection。

我希望我解释了我自己。

我们都知道养蜂场岩石（或者不是......我认为它确实如此），我想知道如何进一步允许用户导出 API 的 JSON 描述？（因此开发人员可以编写客户端代码生成脚本）

这应该有帮助： http ://ttezel.github.io/blog/2013/02/23/stop-writing-rest-api-clients/