问题标签 [apiary.io]

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 投票
1 回答
4237 浏览

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

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

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

最终结果是以下文本:

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

0 投票
3 回答
2471 浏览

markdown - 如何重用 API BluePrint 架构中的对象?

我创建了一个 API,它提供了一个名为“Thumbnail”(/thumbnails)的资源

另一方面,我有多个资源,其中包括该缩略图资源(如 /articles、/videos ...):

当我在 BluePrint markdown 中编写这些 Web 服务的模式时,我希望能够重用我为缩略图模式创建的模式,以免重复模式中的代码。我很喜欢 Trait 功能(https://github.com/apiaryio/api-blueprint/issues/47),但我不知道它是否符合我的需求,以及它是否适用于 aglio 和 dredd。

你知道在我的情况下最好的办法吗?

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 投票
2 回答
1082 浏览

powerbi - 无论是否使用 ApiaryIO,都无法通过 API 更新 Power BI 表架构

我正在使用 Power BI API。我有一个包含一些表和行的数据集。

Power BI API 控制台检索数据集或表时我没有任何问题。

但是,表资源上的 PUT 动词更新其架构总是返回 504 - 代理请求超时

这是我第一次使用 Apiary IO,所以这可能是它的问题,而不是 Power BI 更新,但这让我产生了一些问题:

  1. 是否有任何解决方法可以使用 Fiddler 等测试 Power BI?我可以输入 url 和正文,但如果我没记错的话,我需要一个带有 OAuth2 令牌的 Authorization 标头。我怎么能得到那个?ApiaryIO 似乎隐藏了它。
  2. 根据更新架构文档,带有资源的 URL 是https://api.powerbi.com/v1.0/myorg/datasets/{myDatasetId}/tables/{myTableName} ,动词是PUT. 那么"name": "???"JSON 正文中的参数的含义是什么?是表名还是其他什么?我假设它是表名,但它似乎是多余的,因为我已经{myTableName}根据给定的 URL 访问资源。
  3. 我的最后一个相关问题是如何在不修改其数据的情况下重命名特定表的列?这是我试图通过更新架构来实现的,但我不明白 Power BI 如何知道我要重命名的列。

谢谢!

0 投票
1 回答
815 浏览

jsonschema - MSON 指定日期时间

以下 MSON 如何输出具有“格式”:“日期时间”的模式,类似于下面所述?

女士:

获得的 Json Schema:

所需的模式(注意“格式”字段):

0 投票
1 回答
471 浏览

apiary.io - 如何格式化养蜂场蓝图的默认日期?

目前,我正在尝试使用以下格式修复以下 2 个警告。

我的警告是:

Specifying parameter 'start' as required supersedes its default value, declare the parameter as 'optional' to specify its default value.

Specifying parameter 'end' as required supersedes its default value, declare the parameter as 'optional' to specify its default value.

0 投票
1 回答
2560 浏览

api - 对象的蓝图数组(养蜂场)

我正在尝试使用基于此答案的语法来描述对象数组

但是养蜂场呈现的是

是bug还是我弄错了?