问题标签 [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 回答
210 浏览

attributes - 为什么 Apiary 中的属性总是按要求显示在文档中,即使设置为可选?

我在数据结构部分创建了一个对象,如下所示:

然后在其适当的资源中,我在请求操作中使用该对象:

在我的文档中,它仍然总是像下图一样显示它是必需的(描述也没有显示在那里)。然而,在生成的 JSON 模式中,一切都是应有的。

这是一个错误,一个尚未完全支持的功能,还是我在我的标记中做错了什么?

文档! YU 没有显示我的设置?

0 投票
1 回答
701 浏览

parameters - 更多具有不同 URI 参数的 [GET] 请求-响应示例

我有一个 URI:/lessons/{language}/{type}

我想在我的蓝图中有更多具有不同参数 {language} 和 {type} 的模拟请求响应。在我看来,这对于 GET 方法是不可能的。

我的想法是: GET /lessons/cs/easy 将返回:

并且 GET /lessons/de/easy 将返回:

这是我的语法(在下面),它不起作用。

此语法不起作用。 我想要这样的东西

这是它在预览中的样子。 这是它在预览中的样子。

0 投票
1 回答
1144 浏览

swagger - 选择一个工具来记录 REST API

我实际上使用 Doxygen 来记录我的 php REST 应用程序,我只是发现 Apiary 和 Swagger 女巫似乎是记录 API 的好工具......我想知道是否有一种方法可以使用其中一种工具(apiary 或swagger ) 基于代码注释?

0 投票
1 回答
4237 浏览

apiblueprint - 在 Apiary 中表示输入参数是日期/时间的正确格式是什么?

我正在编辑我正在处理的项目的一些 Apiary 文档,并且需要指出我的 API 调用之一的参数是日期时间字符串。Apiary 似乎对这个参数的格式感到窒息,所以我想知道在 Apiary 中记录这个参数的建议方法是什么。

为了演示,我从 Apiary 中获取了标准的默认文档,并修改了Choice文档以获取日期时间对象,如下所示:

最终结果是以下文本:

这显然是错误的,甚至记下示例值。破折号 ( -) 是一个特殊字符,在这里会引起悲伤。正确执行此操作的推荐方法是什么?

0 投票
1 回答
2088 浏览

apiblueprint - 在 apiary 中定义 json post 参数

我正在尝试使用 json 发布请求为项目创建文档。
现在对于获取请求,我可以轻松定义 uri 参数。

但是我想对 json 和其他 post 请求做同样的事情。
我试过并希望它可以像下面那样工作,它显示示例中的参数,但它似乎不是这样做的方法......
有没有办法正确地做到这一点?

0 投票
1 回答
418 浏览

apiary.io - 限制响应返回的蜂房

所以我使用 Apiary 来保存数据数组,然后调用数据以在 HTML 上显示,但我只希望 Apiary 将有限数量的数据发送到 HTML,而不是完整的数组。仍在尝试了解 Apiary 语法,所以只是想知道我是否朝着正确的方向前进(或者我会通过前端这样做吗?),因为我使用的东西不起作用并且文档不是'我不清楚:

0 投票
1 回答
895 浏览

apiblueprint - MSON 描述蓝图中的对象属性

我有一个类似于这里描述的问题。

我有一个如下所示的 JSON:

我正在尝试使用 MSON 描述属性,以呈现蓝图。但是,我在这方面并不成功。这是我的尝试:

任何人的想法?任何输入将不胜感激。

0 投票
1 回答
732 浏览

apiblueprint - 在 API 蓝图/MSON 中使用模式

我正在研究 API 蓝图中的新数据结构语法的可能性,尤其是 MSON。是否可以附加或指定类似模式(正则表达式)的东西?在这个主题上没有找到任何东西。

0 投票
1 回答
102 浏览

apiary - 谁“拥有”养蜂场蓝图?

如果我在 apiary.io 上创建一个蓝图,然后将Editor权利授予其他几个人,那么“我”是否还有挥之不去的特殊性?

如果是这样,我怎样才能确定谁“拥有” bp?

特别是,我为几个电子邮件地址创建了 Apiary 帐户,并将它们都设为编辑。我现在正在尝试使用 CLI(github:apiaryio/apiary-client)。当我为多个“编辑器”帐户使用生成的令牌(在 login.apiary.io/tokens)时,它告诉我“403 Forbidden”。我如何选择“真正的所有者”帐户(显然,我已经忘记了)来尝试 CLI?

0 投票
1 回答
2563 浏览

rest - Apiary.io 和/或 API 蓝图是否支持 api 版本控制?

api blueprint 或 Apiary.io 是否支持对 API 进行版本控制的概念?特别是,我通过这样的 URI 对我的 API 进行版本控制:

在上面的示例中,这意味着我正在调用 API 的版本 2(“v2”)。api 蓝图是否支持这个?如何记录给定操作或整个 API 的多个版本?