2

accounts「名前」または「ステータス」に基づいて「 」を検索 (たとえば) したい。

だから私は2つのアクションをしたいと思います:

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

どうすればそれを文書化できますか?

複数のトランザクションでアクションを試しました：

### 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ブロックが認識されません:

    認識されないブロックを無視する

どうもありがとう

4

1 に答える 1

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}
于 2014-10-02T18:39:39.767 に答える