问题标签 [apiblueprint]

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和其他一些选项。但我没有得到更多关于失败的信息:(

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

我正在为响应中包含的字段不同的 API 编写规范。我希望能够提供多个示例来说明这一点。我的用例是：

1. 其中一个 API 调用有一个include参数，允许用户指定一些附加字段以包含在响应中
2. 对于某些 API 调用，响应中包含的字段取决于与用户的 API 密钥关联的权限

我想做的是这样的：

据我所知，尽管您可以提供多个响应，但只有在响应代码或内容类型不同时才能这样做。有没有办法做到这一点？

我想知道我应该如何使用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 检查响应正文吗？我该怎么做？

我一直在考虑一个文档工具，用于为要在多个客户端中使用的 Web 服务构建后端，以及 OAuth 和多个修订的可能性。我已经知道养蜂场了，但做了一些研究，我发现了其他相当不错的解决方案，并承诺有利可图。

RAML 似乎承诺良好的代码生成和 api 可重用性。但它似乎无法创建模拟服务器。而且我不明白为什么 apiblueprint 不能用于为 REST API 生成客户端库和服务器端骨架。

对我们来说，最好的用例是 API 文档，可以自动生成用于使用服务的客户端 iOS/Android/wp/js 库以及提供框架以编写代码的 node express/restify 应用程序。连同 api 测试和负载测试。

RAML/Swagger/Apiary 中的哪个解决方案最适合这个？

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

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

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

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

但这引入了两个问题：

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

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

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

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

谢谢！

在 API 蓝图中，我希望为 POST 消息指定一个可选的 json 元素。例如；

我如何向 API 的读者表明年龄在 API 调用中是可选的，但仍显示它是一个整数？

~科林

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

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

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

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

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

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