1

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

这是链接定义：

### Get hotels availability [GET /agent/v1/hotel/availability{?regions,hotels,from,to,limit,offset}]

参数：

+ Parameters 
    + regions (required,string,`399,189`)
    + hotels (optional, string, `1844`)
    + from (optional, string, `2016-03-12`)
    + to (optional, string, `2016-03-19`)
    + limit (optional, number, `1`)
    + offset (optional, number, `0`)

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

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

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

4

1 回答 1

5

我不确定我是否正确理解了您的问题。我试图重现您描述的行为。我在 Apiary 中创建了一个新的 API 项目并编写了以下 API 蓝图：

FORMAT: 1A

# Hotels API

# Group Hotels

## Hotels [/agent/v1/hotel/availability{?regions,hotels,from,to,limit,offset}]

+ Parameters 
    + regions (required,string,`399,189`)
    + hotels (optional, string, `1844`)
    + from (optional, string, `2016-03-12`)
    + to (optional, string, `2016-03-19`)
    + limit (optional, number, `1`)
    + offset (optional, number, `0`)

### Get hotels availability [GET]

+ Response 200 (application/json)

        {"hello":"world"}

然后我在生成的交互式文档中打开控制台窗格并尝试编辑 URL 参数：

编辑 URL 参数

顶部的 URL 正在正确更改。我向控制台提出了一些请求，Traffic Inspector 页面似乎确认已发送正确的参数：

在此处输入图像描述

我认为您必须完善您的问题并提供更多信息。此外，我相信这是相当特定于 Apiary 的主题，因此联系 Apiary 支持可能更有意义support@apiary.io。如果电子邮件不是你的东西，还有一个交互式聊天：

在此处输入图像描述

免责声明：在撰写答案时，我为 Apiary 工作。

于 2016-02-18T16:53:07.487 回答