LoginSignup
3
6

More than 5 years have passed since last update.

API Blueprint の書き方メモ

Last updated at Posted at 2018-10-15
## API名 [/endpoint_name]

### 注文(order)の order を取得 [GET /order/{owner_id}/{?ids,type,period}]
注文(order)を取得

+ Parameters

    + owner_id: 1 (number) - ownerId
    + ids:`1,2,3` (string, require) - IDをカンマ区切りで
    + type:`recently` (string, require) - type 選択
    + period:`2018` (string, optional) - 必須じゃないやつ

+ Request

    + Headers
        Authorization: Bearer {token}

+ Response 200 (application/json)

    + Attributes
        + count:1 (number, require) - 全体のカウント
        + pageNo:1 (number, require) - 現在のページ番号
        + items (array[object], require) - 注文アイテム

    + Body
        {
          "items": [
            {
              "id": 10,
              "name": "order10",
            },
            {
              "id": 15,
              "name": "order15",
            }
          ],
          "count": 3,
          "pageNo": 1
        }

3
6
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
3
6