与参数相同的动作的不同请求

时间:2014-10-02 12:36:23

标签: apiblueprint apiary.io

我想搜索(说)" accounts"基于" name"或者"状态"。

所以我想有两个动作:

  • GET /persons/?q=name==Jea*
  • GET /persons/?q=status==locked

我该如何记录?

我尝试了Action多次交易:

### GET /accounts{?q}

+ Request by name
    +Parameters
        +q (required, FIQLQuery)
        **Only name is supported**

+ Request by status
    +Parameters
        +q (required, FIQLQuery)
        **Only status is supported**

但是Apiary编辑抱怨是因为:

  1. 我必须为我的GET请求提供一个消息正文:

      

    消息正文资产应该是预先格式化的代码块,其每一行都缩进8个空格或2个标签。

  2. 无法识别+ Parameters块:

      

    忽略无法识别的块

  3. 非常感谢

1 个答案:

答案 0 :(得分:0)

我可以制作适合我的解决方案。

试试此API蓝图:

FORMAT: 1A

# requestByname

## Accounts [/accounts/?{q,type}]

### GET

+ Parameters
    + q (required, FIQLQuery)
    + type (string, `name` or `status`)

+ Request Name (application/json)

+ Response 200

        {"name": "test"}

+ Request Status (application/json)

+ Response 200

        {"status": 200}