问题标签 [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.
apiblueprint - apiary 中的必需参数不是必需的
我正在尝试使用 apiary（apiblueprint）创建我的 api，但是当我将发布数据发送到我的端点时，我总是得到 201 响应。但是端点需要一些参数，所以当我发送空帖子时，我应该收到一些错误消息。我该怎么做？
apiary.io - 调用 API 时出现 Apiary 错误
我在 Apiary 上收到以下错误很抱歉，API 调用失败。
我的主机定义为 FORMAT: 1A HOST: https://test.mynetwork.com/
GET CALL 定义为
数据骨灰盒 [models/v2/files/{urn}/data{?guid}]
得到 [得到]
参数
- 瓮（必需，字符串，
ttt）...设计瓮。 - guid（可选，字符串，
067e6162-3b6f-4ae2-a171-2470b63dfe02）...按 guid 过滤。
- 瓮（必需，字符串，
响应 200（应用程序/vnd.api+json）
- 正文数据{“版本”：“1.0”，}
当我调用它时，我得到错误。任何输入
apiblueprint - 无法呈现 JSON/JSONSchema。MSON 定义中的对象成员类型无效
我有 API 文档，突然没有任何更改，它开始unable to render JSON/JSONSchema. Invalid member type of object in MSON definition在 Response 200 (application/json) 行抛出验证警报。
我试图用谷歌搜索它，但我看不出我做错了什么。感谢帮助！
webhooks - 如何在 Apiary/API 蓝图中记录 Webhook
我只是从 api 蓝图开始，使用 apiary 为我们的 api 生成文档。我们有一个 REST api 和一些 webhook。REST api 很容易创建，但我不知道如何最好地为 webhook 生成文档。
我们想在我们的 webhook 和 REST api 之间共享数据结构。
到目前为止，我唯一能想到的就是像 REST 资源一样记录 webhook。这感觉有点奇怪，因为通常 webhook 文档只是有效负载信息，但也许这是最好的选择。
有人这样做吗？或者也许有更好的工具可以解决这个问题？
最终会喜欢 github 所做的事情：https ://developer.github.com/webhooks/
apiblueprint - 如何在所有 Apiary/Blueprint API 请求中指定共享标头部分？
我有一个大型 API 文档，每个请求都有相同的请求标头，例如Accept: application/json和Cookies: SessionID。有没有办法可以全局声明这些以避免重复？
apiblueprint - 基于另一个参数值的条件参数
如果我有条件可以根据另一个参数的值更改某些参数，那么参数的格式是什么。例如：我有付款方式：paypal、银行转账等。
如果方法的值为“paypal”，那么我的服务需要额外的参数：
如果方法的值是“银行转账”，那么我的服务需要额外的参数：
apiary.io - 如何在 apiary.io 中编写代码片段？
我正在使用 apiary.io 并添加了所有宁静的端点。看起来很棒，有许多语言的代码片段如何发出 GET 请求并获得结果。
现在，我想在文档中添加一个代码片段，它与任何端点都不相关（例如身份验证过程）。我希望此代码显示在右侧，而无需单击任何链接。我能以某种方式实现这一目标吗？我想像在我的 IDE 中那样突出显示和缩进代码。我正在使用 Python，如果相关的话。
先感谢您！
apiblueprint - Dredd 找不到我的 API 文档，如果它不在我的本地驱动器上（它在 apiary.io 服务器上），我如何告诉它它在哪里
我正在使用Dredd工具来测试我的 API（位于 apiary.io 上）。
问题
我想为 dredd 提供我的文档的路径（它甚至要求它），但是我的 API 文档在 apiary.io 上，但我不知道指向它的确切 url。为 dredd 提供 API 路径的正确方法是什么？
什么有效（但不是我想要的）
注意：我尝试将 api 下载到我的本地驱动器并为 dredd 提供文件的本地路径（yml 或 apib），它可以正常工作（耶！），但我想避免保留本地副本并简单地提供 dredd我在养蜂场服务器上维护的真实 API 文档的位置。
我该怎么做（无需先将文件提取到本地驱动器）？
试图解决这个失败的问题
我还阅读（并尝试过）以下主题，它们可能是相关的，但我没有成功解决问题 - 使用身份验证令牌作为环境变量 - 将 apiary.io//settings 提供的域提供给 dredd - 提供在 dredd 命令中，所有这些尝试仍然产生相同的结果，Dredd 不知道在哪里可以找到 API 文档，除非我在本地计算机中提供文件的路径（我必须先在我的计算机上下载或手动创建） .
任何帮助表示赞赏，谢谢！
apiblueprint - 无法使用 apiary CLI fetch 命令获取 apiary.apib（即使我正在使用我的 apiary 访问令牌）
我正在尝试将我的养蜂场文档（在养蜂场服务器上）获取到我的本地驱动器。我是 API 的所有者，可以访问“设置”按钮（我认为这可能很重要，因为最后我得到了 403 禁止响应，见下文）。
安装apiary CLI后，我按照以下步骤操作：
注意：在 windows 上运行（使用 cmd/powershell 执行命令）。
- 从这里获取访问令牌
- 设置新的环境变量 APIARY_API_KEY=访问令牌。
运行以下命令（我可以在 apiary.io 上轻松找到 API 名称）
/li>
我希望将 API 文档（到目前为止，我一直在通过浏览器处理 apiary.io）获取到我的本地驱动器 - 这允许我在本地编辑它以运行其他工具（dredd）来验证我的 API 与获取的文档.
相反，我得到了这个回应：
可能是什么问题，我可以在 apiary.io 上轻松查看/编辑我的 API，那么为什么我不能使用 apiary CLI 访问它？
（已编辑）图片已添加
swagger - 如何为内容类型的响应正文提供示例值：Swagger 中的 text/html（使用 dredd 进行测试）
我有一个 API 调用，它响应 200 OK 并返回一个 HTML。我想将此添加到我的 API 文档中（特别是因为我使用 dredd 对其进行了验证，除非我向其提供预期的响应正文，否则测试失败）。我将如何在 Swagger 中做到这一点？
--- 更多详细信息 --- 我对 API 调用的响应为 200 OK，并且带有一行响应正文：
<html><body>You are being <a href="https://my.domain.com/users/sign_in">redirected</a>.</body></html>
我可以在蓝图中轻松定义响应体，格式如下：
但我不确定如何在 Swagger 中做到这一点。我能找到的几乎所有示例都是针对应用程序/json 响应的（可以理解），我无法猜测这种响应的正确语法。
我的文档中相关的招摇文本是这样的（到目前为止没有指定响应主体，因此使用空主体 dredd 失败，因为响应主体应该是<html><body>You are being <a href="https://my.domain.com/users/sign_in">redirected</a>.</body></html>）：
如果您对此有任何建议，请发表评论。谢谢！