问题标签 [apiblueprint]

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 回答
365 浏览

apiblueprint - 使用 API 蓝图在 SoapUI 中创建新项目期间出现 SSLException

我正在尝试使用 SoapUI 的 API Blueprint 插件。我已经尝试过 SoapUI 版本 5.1.0、5.1.2 和 Ready!API 1.2.2,所有结果都相同(我组织中的其他人也遇到了同样的问题)。

当我尝试创建类型为“API Blueprint Definition (REST)”的新项目时,在导入阶段,我收到以下错误(消息末尾的完整堆栈跟踪):

我看到在这个阶段有人调用了https://api.apiblueprint.org:443,但似乎操作成功了。

正如我在其他一些帖子中看到的那样,我尝试向 .vmoptions 文件添加一些属性,但它们没有帮助:

由于日志不是特别有用,我无法解释正在发生的事情。

有任何想法吗?

谢谢,伊恩·W

0 投票
1 回答
1206 浏览

rest - Aglio 不允许将 body 中的参数定义为参数

Aglio 是一种 API 蓝图渲染器,不允许将请求正文中的参数包含在端点规范的参数部分中。它抛出解析警告如下:

parameter '<some_parameter>' not specified in '<some_description>' its '<some_URI_template>' URI template (warning code 8)

复制此警告的示例 Markdown 是:

渲染不喜欢 'destination' 作为参数,因为它不在 URI 模板中。

我的问题是,这是该工具的一个缺点,还是 API 蓝图规范?另外,也许,REST 端点的定义不符合标准?

0 投票
1 回答
4173 浏览

apiblueprint - 如何在 API 蓝图中指定请求标头

我正在尝试为利用请求标头来了解要返回的内容类型的资源定义 API 蓝图。

我希望我的要求如下:-

我如何使用 API 蓝图记录它?

0 投票
2 回答
2558 浏览

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

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

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

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

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

0 投票
1 回答
146 浏览

apiblueprint - 带有虚假数据的 API 蓝图

我正在使用 Faker 为我的大部分只读 REST API 播种我的数据。我已经查看了用于测试 API 的 API 蓝图,但是我对如何使用不一致的伪造数据来实现这一点感到困惑。看来您必须为指定的查询定义确切的 json 输出。

关于使用 API Blueprint 和 Faker 的任何提示?

0 投票
1 回答
1407 浏览

json - JSON 到蓝图/MSON

我还没有找到任何用于这种转换的工具,有没有人知道任何存在的。

目前,我有来自 Swagger 的 JSON 数据,我想将其转换为 Blueprint/MSON 以与 Apiary 一起使用,但我不确定这是否可行。任何建议都会非常有帮助,或者建议其他路线尝试将我的 API 加载到 Apiary 而无需手动编写它。

0 投票
1 回答
1631 浏览

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

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

0 投票
2 回答
1249 浏览

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

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

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

0 投票
1 回答
96 浏览

api - 如何在 API 蓝图中获取对请求的响应

我们正在研究使用 API 蓝图。在某些情况下,我们希望在 Request 的基础上得到 Response。所以,任何人都知道我们如何在 API Blueprint 中做到这一点。

0 投票
1 回答
109 浏览

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

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

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