食物

食材搜索

0次调用
1 积分/次

正在开发减脂打卡 App 或是健康饮食工具?只需输入如“白菜”、“鸡胸肉”等日常食材,立刻返回它的热量和健康评级。

GET
uapis.cn
/api/v1/food/ingredient
查询参数
2
keyword
string
required

食材关键词,长度不超过 64 个字符。

page
integer

分页页码。范围 1-100。

功能概述

调用此接口,你将获得一组按相关度排序的食材列表,通常第一页的第一条就是你要找的最佳匹配项。每条结果包含:

  • 食材编码 (code):食材的唯一标识,用于请求其完整的营养详情。
  • 热量 (calory):食材每 100 克的基础热量(大卡)。
  • 健康红绿灯 (health_light):直观的食用建议(1 为绿灯推荐食用,2 为黄灯适量食用,3 为红灯少量食用)。

查询参数

keyword
string必填

食材关键词,长度不超过 64 个字符。

page
integer可选

分页页码。范围 1-100。

响应

200 / 请求成功

搜索成功,返回匹配的食材概览列表。

JSON
{
  "keyword": "白菜",
  "count": 10,
  "total_pages": 2,
  "items": [
    {
      // 食材编码,用于详情接口
      "code": "xiaobaicai",
      "name": "小白菜",
      // 每 100 克热量(大卡)
      "calory": "14",
      // 热量对应的克重基准
      "weight": "100",
      // 1 绿灯 / 2 黄灯 / 3 红灯
      "health_light": 1,
      "thumb_image_url": "string",
      // 每 100 克碳水化合物(克)
      "carbohydrate": 2.4
    }
  ]
}

400 / 错误的请求

参数错误,请检查 keyword 是否为空或超出长度限制。

JSON
{
  "code": "INVALID_PARAMETER",
  "message": "keyword 不能为空"
}

404 / 未找到

没有找到匹配的食材。

JSON
{
  "code": "NO_MATCH",
  "message": "没有找到相关结果: xxx"
}

502 / 网关错误

服务暂时不可用,请稍后重试。

JSON
{
  "code": "SERVICE_UNAVAILABLE",
  "message": "服务暂时不可用,请稍后重试"
}