问题标签 [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

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

我刚刚开始使用 Apiary，我不知道这是产品的限制，还是我不知道该怎么做。

我正在记录一个 API，它将用户身份验证为每个请求的一部分。有时身份验证是路径的一部分（对用户配置文件的请求将在路径中包含用户 ID），其他时候只是作为参数 (?user_id=1&auth=secret)，对于 POST 请求，作为传入正文的一部分JSON。

此外，应用程序中有 3 种身份验证方法。您可以使用 Facebook UID、电子邮件地址或使用您正在使用的设备的唯一 ID 登录。结果是这样的：

这工作正常，并按我的预期显示在 API 中：

但这引入了两个问题：

1）如果我想添加一组所有身份验证方法共享的参数，我需要将它添加到所有 3 中，如下所示：

这似乎有点乱，在路径数组的末尾应用共享参数会更好，这样它们就适用于所有人，如下所示：

但这不起作用。有没有办法做到这一点？该文档对于像这样更复杂的东西不是很有帮助。

另外，是否有一种方法可以创建某种可以应用于所有方法的模板？在身份验证是路径的一部分的情况下，它有点不可避免，但对于其他请求，只需执行类似的操作include: authentication并让它从某个定义的模板中提取 unique_id/auth 组合会很好。

谢谢！

我对 javascript 和调用 API 很陌生。这是我的代码。我正在尝试在 apiary 上调用 API。

API 调用链接到事件侦听器（按钮单击）：

目前，如果我向 googleAPI 发出请求，我会得到一个成功的响应（即建立连接），如果我尝试向 apiary 发出请求，它会失败。

我不确定这是否是正确的方法，但是根据我的理解，在 apiHelper 建立连接后，我应该能够正常访问该对象，即。.方法名称。

无论如何，我需要对此进行一些澄清，干杯。

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

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

我正在尝试在 API Blueprint 中记录一个查询参数，但我不完全确定我是否做得正确。资源如下所示：

该请求将停用用户，而以下将删除用户对象：

这是我为此准备的蓝图降价：

但是，当使用 Apiary 渲染它时，我只能force在参数列表中看到它，但它现在显示在示例 URL 中。这只是我误解了 GUI 还是应该以其他方式记录查询参数？

我正在记录一个 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/

It seems you can only refer to the model itself in an unmodified form from a payload/body section:

Is there any way to return an array of the model or use the model as a field? I.e. something like