问题标签 [apiary]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
2 回答
2558 浏览

apiblueprint - 如何在 Apiary.io 中显示嵌套属性定义

我有一个定义如下的数据结构:

我试图在另一个动作定义中使用这个数据结构,如下所示:

我希望 Apiary.io 文档不仅显示顶级属性的定义,还显示 PlayerRank 对象的定义。作为一名试图理解 UI 的开发人员,我想查看每个对象和字段的定义,以便知道如何正确地形成请求。现在它只给出了 playerRanks 对象的描述,即:“指定每个玩家的游戏等级和得分的 PlayerRank 对象的集合。” 但它没有扩展定义以显示 PlayerRank 数据结构的所有属性。

知道 Apiary.io 文档是否可以促进这一点吗?

0 投票
1 回答
487 浏览

apiary.io - 如何将 API 版本添加到 Apiary Mock Server

有没有办法将 API 版本添加到 Apiary Mock Server?

例如:httpv1 : //private-XXXXX-apiname.apiary-mock.com//mocks/1?school_id=1

0 投票
1 回答
1631 浏览

apiblueprint - Apiary 中 Host: 参数的用途是什么?

Host:Apiary中参数的用途是什么。例如:

0 投票
2 回答
1249 浏览

rest - apiary:忽略无法识别的块

对于发布访问权限的服务,我在 apiary 中有以下定义:

Apiary 告诉我请求和响应块无法识别。我试图使字段成为必填项,我使参数成为必填项,我更改了字段的拼写,我删除了(应用程序/json),我摆弄了间距。似乎没有任何帮助。请求和响应块有什么问题?

0 投票
1 回答
109 浏览

apiblueprint - 养蜂场推荐行工具以 503 响应

我正在使用命令行 apiary 工具(离线)生成 HTML 格式的文档。有时我会看到此错误“Apiary 服务响应错误:503 服务不可用”。我的问题是

  1. 这个错误是什么意思。
  2. 此离线工具是否会联系一些在收到错误时无法访问的外部养蜂场服务。
0 投票
1 回答
305 浏览

apiblueprint - 在蓝图中指定嵌套(对象)?

我的嵌套对象属性没有显示错误/警告,但在 apiary.io 中没有有用地显示。我究竟做错了什么?

我有一个这样的结构(响应体):

{ "f1": "v1", "f2": "v2", "f3": { "f3f1": "v3v1", "f3f2": "v3v2" } }

当我阅读几个规范时,这应该被描述为

+ Attributes - f1: v1 - f2: v2 - f3 - f3f1: v3v1 - f3f2: v3v2

并且 apiary.io 应该显示一个表(除其他外)显示所有四个示例值。

但是结果表没有提到子对象。

可以这样做(是否支持)?如何?

0 投票
1 回答
1277 浏览

apiary.io - 蜂房代理请求超时

我正在尝试使用 Apiary 记录我的 API 和测试请求,但我不断收到响应 504 代理请求超时。我的 API 在我的机器上运行在http://localhost:3000/下,我在 HOST 元数据下指定了它。当我单击调用下的比较时,它显示 Apiary 添加了一个标头“主机”,它指定了用户特定的代理。有什么我遗漏的东西还是 Apiary 不像本地主机?

0 投票
2 回答
560 浏览

json - 多个单个对象的 APIARY 模拟 JSON 数据

在我的养蜂场中,我定义了以下内容以在将 id 传递给带有所有详细信息的单个 Note 对象时检索一个 id

http://private-22c1f-polpan.apiary-mock.com/notes/2

如果我想通过传递 3 传递另一个 id,如何在 apiary 中定义 JSON 条目?

但是,当我尝试

http://private-22c1f-polpan.apiary-mock.com/notes/3

它没有返回 id 3 的详细信息。

我该如何解决这个问题?

0 投票
2 回答
4172 浏览

json - MSON 中的对象嵌套数组在 Apiary.io 文档中为空

我想创建一个嵌套数组,其中包含 MSON 格式的对象,以与 API Blueprint 和 Apiary 一起使用。我的代码看起来是正确的,但是当我在 Apiary 中渲染它时,我没有得到预期的 JSON。

我要创建的示例:导航有多个类别。每个类别可以有多个子类别。每个类别和子类别都有一个名称。

我为此创建的 MSON:

我期望的 JSON 输出:

我在 Apiary 中得到的输出

0 投票
2 回答
6266 浏览

rest - Apiary.io - 具有不同参数的多个响应(200)

我试图通过不同的参数获得不同的响应,但有些东西不起作用。

这是我的 API:

但是当调用 /questions/1 或 /questions/2 时,响应总是相同的:

怎么了?

谢谢