问题标签 [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 投票
1 回答
350 浏览

apiblueprint - How can I hit a local dev server from UI generated by apiary command line tool

I am using apiary preview --server to watch a file while editing it and have a UI generated.

I would like to hit a local dev server in the "Try" section of the UI, but when I hit "Call Resource", a request is made to POST https://jsapi.apiary.io/apis/null/http-transactions/.

HOST is set to http://localhost:3050 and I'm expecting it to hit that endpoint.

How can I change this?

$ apiary version 0.5.2

enter image description here

0 投票
1 回答
165 浏览

apiblueprint - API 蓝图 - 使用数据结构作为响应,没有属性

我正在使用 Apiary 来模拟一个新的 API。

我试图避免一遍又一遍地写出所有 JSON 响应。如果我使用 a + Attributes(user)then 执行此操作,它将在机器面板中自动生成一堆属性块,这在我看来非常令人困惑(尤其是当您有多个响应时)。

如果您手动写出 JSON 请求/响应块,生成的文档看起来会更好。

有没有办法将请求/响应对象存储为数据结构?也许是一个模型?

我希望能够做这样的事情:

注意:该user对象在现实生活中有 30 个属性长。

0 投票
2 回答
759 浏览

apiblueprint - API 蓝图 - 避免重复授权块

在 API Blueprint 中,如何避免对每个端点反复使用相同的请求授权标头块?

有没有办法在数据结构中对此进行模板化?

0 投票
1 回答
169 浏览

apiary - 如何在 Apiary 中重用 RESPONSE

有没有办法在 Apiary 中重用响应?我认为数据结构不是正确的方法,但我找不到其他任何东西......

0 投票
1 回答
938 浏览

mocking - 如何为 Apiary Mock Server 提供模拟数据?

apiary服务提供 Mock Server,它是基于 API 蓝图或 Swagger 语法编写的 API 描述生成的。

在我的 API 描述中,我有一个返回数据集合的操作。这个集合很大,所以有过滤和分页。Apiary 给了我模拟服务器。但是这个模拟服务器返回的集合只有 1 个该操作的结果。

问题是如何为 Mock Server 提供更多数据?这个想法是在没有真正的服务器的情况下开发前端应用程序,直到它准备好。

0 投票
1 回答
400 浏览

apiary.io - Apiary:POST 请求中的不同主体可能会有不同的响应?

使用 Apiary.io,是否可以将请求 POST 到同一端点,该端点在正文中包含不同的内容,并根据请求正文返回不同的 HTTP 201 响应?

只是,我们有一个 API,它根据在请求中接收到的数据返回计算数据。请求中的数据是通过 POST 发送的,因为数据量对于 GET 来说可能太多了。

以下不是我的数据示例,而是我尝试实现的示例。一个端点,但有两个请求和两个响应;因此,如果发送了第一个请求,则应该返回第一个响应,如果发送了第二个请求,则返回第二个响应。

0 投票
1 回答
438 浏览

apiblueprint - 如何使用 apiary 导入文件?

我想从我的系统中浏览一个文件,并希望使用 apiray 将其导入,所以我该怎么做,请帮助我。

0 投票
1 回答
834 浏览

apiary - 养蜂场蓝图中是否有指定字段长度(大小)/格式的最佳实践?

如果使用 MSON,我看到当前包含字段长度的唯一方法是将包含作为描述的一部分。是否有计划为此添加支持,或者是否有任何最佳实践(解决方法)用于此目的?

例如,在下面的 MSON 描述中,我如何指定 tokenType 最大长度为 20 个字符?(人为的例子)

0 投票
0 回答
623 浏览

node.js - 蜂房多部分/表单数据

我尝试使用 multipart/form-data 创建一个 Apiary 请求,这似乎没问题,除非我尝试通过 Apiary 上的控制台实际将其发送到使用 async-busboy 用 Node.js 编写的现有(和功能性)端点我是找回

此请求的 Apiary 蓝图如下所示:

我想知道蓝图片段中是否有任何问题可以修复,或者是否支持,或者问题可能出在服务器本身(但是当我从邮递员发送多部分发布请求时服务器工作, curl 并且使用它的客户端实现也很少)

0 投票
1 回答
724 浏览

apiary.io - 在带有养蜂场的蓝图中使用变量

是否可以定义某种常量参数,我们可以在多个请求中重用?例如,如果我有多个端点并且在所有端点中我需要相同的 id(例如书 id),是否有机会在文档中定义一次该 id 并在请求定义所需的示例值中引用它?

一些:

书籍 [/books/{book_id}]

  • 参数
    • book_id(必填,数字,{bookId})

提前致谢。