ページング
食品検索 GET /v1/foods は page と limit でページングします。
| パラメータ | 既定 | 範囲 | 説明 |
|---|---|---|---|
page | 1 | 1 以上 | 取得するページ番号(1 始まり) |
limit | 20 | 1〜90 | 1 ページあたりの件数 |
limit は 最大 90 にクランプされます。90 を超える値を指定しても 90 として扱われ、
エラーにはなりません。同様に page は 1 未満が 1 に、limit は 1 未満が 1 に丸められます。
# 2 ページ目を 50 件ずつ取得
curl "https://api.example.com/v1/foods?q=あわ&page=2&limit=50" \
-H "X-API-Key: fnk_xxxxxxxx"レスポンス形
検索結果はページ情報付きで返ります。total は条件に一致した全件数です。
{
"items": [
{ "foodNumber": "01001", "name": "アマランサス 玄穀" }
],
"total": 124,
"page": 2,
"limit": 50
}総ページ数は Math.ceil(total / limit) で求められます。items が空になる、または
page > Math.ceil(total / limit) のとき、それ以上のページはありません。
検索は q=(名前の部分一致)や group=(食品群)で絞り込めます。詳しくは
API リファレンスの GET /v1/foods を参照してください。