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

apiblueprint - 在 apiblueprint 文档中显示为“默认”的级别是什么?

当我在 apiary.io 中创建新的 api 文档时,呈现的文档和导航显示在编辑器中不可见的结构级别:

  • 介绍
  • 参考
    • 默认

导航级别

虽然我可以接受魔法生成的最高级别,但我想重命名和复制第二级。

我该怎么做?怎么称呼?它有 CSS 类resourceGroupName但这似乎不是名称。

0 投票
1 回答
1225 浏览

apiblueprint - Apiary.io,相同的路线不同的方法

我试图在 Apiary.io 中定义一个简单的 CRUD 路由,但交互式编辑器抱怨,因为我的一些路由被称为相同:

“资源 '/questions/{question_id}' 已定义”

在此处输入图像描述

我该如何解决这个问题?

0 投票
1 回答
53 浏览

apiary.io - 养蜂场服务响应 410 Gone

我正在使用 apiary 服务使用以下命令生成离线文档

蜂房预览 --path=docs/tmpApi.apib

到目前为止它一直在工作,但今天注意到它给出了错误“养蜂场服务响应错误:410 Gone”。

任何想法,服务出了什么问题?

0 投票
1 回答
1746 浏览

data-structures - Adding comments to data structure in API Blueprint

I have two properties, one of which must be supplied. I was trying to add a comment at the bottom of the data structure but it was ignored. So I tried a multi line description but that was also ignored:

0 投票
2 回答
2297 浏览

image - 如何将图像/图表添加到 API 蓝图?

我们希望将图像集成到 Apiary 上的 API 文档中,作为记录底层应用程序架构或说明示例工作流/序列图的一种方式。然而,通过Apiary 文档API 蓝图规范进行搜索似乎并没有产生任何关于如何做到这一点的结果。

是否可以将图像添加到 API 蓝图?或者这些图像是否必须在外部托管并通过 URL 引用?

0 投票
1 回答
103 浏览

apiary.io - Markdown 使用 Apiary 在“v1”版本的 API 中获取资源

我希望每个 API 版本都有一个 API 文档分段。所以我的主机是:http ://api.clementlevallois.net/apitest/

api版本为:v1

资源是:get/{id}

我希望文档生成:

http://api.clementlevallois.net/apitest/v1/get/ {id}

但是“v1”部分被压缩了,我得到了: http: //api.clementlevallois.net/apitest/get/ {id}

这是我的降价:

如何在 URI 中插入“v1”部分?

0 投票
1 回答
652 浏览

apiary.io - 如何在 apiary 的 Markdown 中显示可选标题?

如何通过 apiary 的降价来指示请求的一个特定标头是可选的?

我的代码:

  • 请求
    apiKey 可以在标头中传递(注意“apiKey”
    的驼峰式) Content-Encoding: gzip 是可选的,只有当你 gzip 实体时

    • 标头

      /li>

以上可以吗?

0 投票
1 回答
267 浏览

apiary.io - Dredd 似乎挂起对 asp.net kestrel 服务器的 api 调用

当我运行 dredd 时,它似乎只是在第一次 api 调用之后挂起。我不确定如何调试或诊断。我正在使用dnx web命令运行 asp.net 5 mvc 6 api 服务。我怎样才能看到正在发生的事情或问题可能是什么?

我尝试添加用于调试的钩子,发现它调用了第一个 api,然后就永远不会触发 after 事件。我用邮递员和 curl 测试了 api,结果正确。如果我使用的是 express node.js 服务器,Dredd 也可以使用相同的蓝图。

唯一失败的组合是 Dredd 与 asp.net kestrel 服务器响应。服务器记录发出请求并发送响应,因此它确实触发了测试,但永远不会完成。

Dredd 是否在寻找某种处理后挂钩,因为我看到服务器使用 dredd 接收请求,而不管 .net 或 node.js 是什么。即使我在另一个进程中启动 .net api 进程,它也不起作用,这有什么关系?无论如何,它应该只是对dredd的http请求,对吗?

它是否关心它从红隼服务器返回?

红隼反应

dredd.yml

dredd命令的控制台输出

测试.apib

0 投票
1 回答
557 浏览

rest - 更改 APIARY GET URL 参数以在内置 REST 客户端中进行测试

在 Apiary 中,我们使用http://baasar.apiary-mock.com/user/ {appId}/{userId} 其中 appId 和 userId 是 URL 参数。

Apiary 有一个内置的 REST 客户端,可以针对模型和生产 API 测试这些 API。

但是,尝试测试上述 API,如何在 Apiary REST 客户端中将 appId 和 userId 更改为真实的东西?

0 投票
1 回答
505 浏览

apiblueprint - 有没有办法发送空的可选查询参数?

我正在为 API 编写文档,但遇到了问题。

这是链接定义:

参数:

例如,当我尝试使用空hotels参数发送请求时,apiary 使用1844而不是空的。如果我尝试将其示例为空,hotels=hotels则发送。

有没有办法为可选参数发送空,或者根本不发送?

这是屏幕截图的链接: http ://www.awesomescreenshot.com/image/1008356/09614be501945b0644fd84a06e311404