问题标签 [apiblueprint]

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

我有一个在 apiary.io 调用 RESTful 服务的 angularjs 应用程序

apiary.io 收到一定数量后是否会限制响应和延迟响应？

如果有，参数是什么？

尝试为使用Rails 的数组参数表示法的 API URI 使用资源丰富的文档时，我运气不佳

例如（为了清楚起见，未编码的 URL）：

/api/v2/profiles?ids[]=35&ids[]=47&ids[]=12&ids[]=132

和实际编码的 URL：

/api/v2/profiles?ids%5b%5d=35&ids%5b%5d=47&ids%5b%5d=12&ids%5b%5d=132

这不起作用：

针对 beta 3 列布局进行测试。还没有尝试过旧布局。

我希望能够将参数记录为 URL 参数，因为我喜欢这些文档如何呈现一个方便的表格。但是，在我的 API 中，我希望将这些参数插入 JSON 正文而不是 URL。有没有办法做到这一点？

Apiary 为声明 URI 参数提供了一个干净的界面，允许通过他们的控制台轻松进行实验，并很好地填充空白界面。

这可以为 json-rpc 或任何 http body 参数做吗？如果没有，这将非常有用。

我正在尝试使用 apiary.io 来记录基于 JSON-RPC 的 API。我可以格式化页面，但控制台根本不起作用。

使用 JSON-RPC，您通常只有 1 个 URI，我们的 API 就是这种情况。因此，在尝试定义方法时，蓝图编辑器会发出警告

Action with method POST already defined...

我想我可以忽略这一点，但在测试时在 apiary 控制台中它只会返回定义的第一个操作的示例响应。有没有人可以解决这个问题？

我目前正在尝试用apiary.io. 系统通过登录请求实现身份验证，该请求返回包含会话 ID 的 http-cookie。

据我所知，浏览器在发出另一个请求时将他之前从主机收到的所有 http-cookie 发送回他是标准的。

看来，在运行由我的蓝图文件生成的测试时，这不是 Dredd 完成的。因此，任何需要用户登录的请求都无法正常进行测试。

是否有可能将请求分别标记为“在运行此请求之前需要”以强制 Dredd 管理这些 http-cookies？

顺便说一句，REST 服务是在Sails.js.mvc 框架中实现的node.js。

我正在使用 aglio 来生成我的 API 文档。我目前正在根据 API Blueprint 规范为此编写原始降价。我想知道是否有办法直接在代码中通过注释生成降价。有人知道这样做的方法吗？