1. 菜谱

查菜谱(recipe-recipeInfo)

1.1 用户界面

手机

适用产品： 搜索

适用产品： 语音助手，搜索

适用产品： 语音助手

1.2 请求

菜谱查询请求

请求报文样例：

  1. {
  2.     "slots": {
  3.         "image": {
  4.             "name": "image",
  5.             "slotType": "string",
  6.             "values": [{
  7.                 "real": "图片的Base64位编码值"
  8.             }]
  9.         },
  10.         "title": {
  11.             "name": "title",
  12.             "slotType": "string",
  13.             "values": [{
  14.                 "real": "红烧肉"
  15.             }]
  16.         }，
  17.         "order": {
  18.             "name": "order",
  19.             "slotType": "string",
  20.             "values": [{
  21.                 "real": "最新"
  22.             }]
  23.         }，
  24.         "keyword": {
  25.             "name": "keyword",
  26.             "slotType": "string",
  27.             "values": [{
  28.                 "real": "川菜"
  29.             }]
  30.         }，
  31.         "ingredient": {
  32.             "name": "ingredient",
  33.             "slotType": "string",
  34.             "values": [{
  35.                 "real": "羊肉：500g"
  36.             }]
  37.         }，
  38.         "queried": {
  39.             "name": "queried",
  40.             "slotType": "string",
  41.             "values": [{
  42.                 "real": "steps"
  43.             }]
  44.         }，
  45.         "queryStep": {
  46.             "name": "queryStep",
  47.             "slotType": "string",
  48.             "values": [{
  49.                 "real": "3"
  50.             }]
  51.         }，
  52.         "id": {
  53.             "name": "id",
  54.             "slotType": "string",
  55.             "values": [{
  56.                 "real": "aa4bfbccf36a5459836db0e6e2c39d36"
  57.             }]
  58.         }
  59.     }
  60. }

成员名称描述是否必选类型取值范围
image图片否string最大长度：1024
title菜谱、食材等名称(如：红烧肉、虾)否string最大长度：32
order排序，1：最热，2：最新。否string最大长度：2
keyword菜系或菜品的功效、标签（如：川菜、秋季养生菜）否string最大长度：64
ingredient食材或配料否string最大长度：64
queried查询菜名：dishName、食材：ingredients、做菜步骤：steps否string最大长度：32，枚举值：  dishName，ingredients，steps
queryStep具体步骤分步（第一步：1，第二步：2……第二十步：20，最后一步：lastStep）否string最大长度：32
id每一道菜对应一个id，根据搜索的id实现做菜步骤多轮交互功能（多轮对话中id标识同一个菜谱）否string最大长度：32

1.3 响应

菜谱信息

响应报文样例：

  1. {
  2.     "items": [{
  3.         "id": "741e208ccb61d3b6e0e97f3755a5d774",
  4.         "title": "红烧羊肉",
  5.         "author": "张三",
  6.         "brief": "",
  7.         "ingredient": "羊肉：600克；胡萝卜：一根",
  8.         "accessory": "冰糖：适量；料酒：适量；生抽：适量；老抽：适量；葱段：适量；姜片：适量；胡椒粉：适量；盐：适量",
  9.         "steps": "1：羊肉浸泡冲洗干净。2：冷水入锅，大火烧开。3：撇去浮沫后捞出冲洗干净......12：加压20分钟后，泄压开盖，
  10.         加入适量盐调味， 即可盛出食用。 ",
  11.         "stepsWithImg": [{
  12.                 "content": "羊肉浸泡冲洗干净。",
  13.                 "image": {
  14.                     "small": {
  15.                         "url": "https://hag.huawei.com/1.jpg",
  16.                         "widthPixels": 72,
  17.                         "heightPixels": 72
  18.                     },
  19.                     "medium": {
  20.                         "url": "https://hag.huawei.com/1.jpg",
  21.                         "widthPixels": 172,
  22.                         "heightPixels": 172
  23.                     },
  24.                     "large": {
  25.                         "url": "https://hag.huawei.com/1.jpg",
  26.                         "widthPixels": 280,
  27.                         "heightPixels": 280
  28.                     }
  29.                 },
  30.                 "position": 1
  31.             },
  32.             {
  33.                 "content": "冷水入锅，大火烧开。",
  34.                 "image": {
  35.                     "small": {
  36.                         "url": "https://hag.huawei.com/1.jpg",
  37.                         "widthPixels": 72,
  38.                         "heightPixels": 72
  39.                     },
  40.                     "medium": {
  41.                         "url": "https://hag.huawei.com/1.jpg",
  42.                         "widthPixels": 172,
  43.                         "heightPixels": 172
  44.                     },
  45.                     "large": {
  46.                         "url": "https://hag.huawei.com/1.jpg",
  47.                         "widthPixels": 280,
  48.                         "heightPixels": 280
  49.                     }
  50.                 },
  51.                 "position": 2
  52.             },
  53.             {
  54.                 "content": "撇去浮沫后捞出冲洗干净。",
  55.                 "image": {
  56.                     "small": {
  57.                         "url": "https://hag.huawei.com/1.jpg",
  58.                         "widthPixels": 72,
  59.                         "heightPixels": 72
  60.                     },
  61.                     "medium": {
  62.                         "url": "https://hag.huawei.com/1.jpg",
  63.                         "widthPixels": 172,
  64.                         "heightPixels": 172
  65.                     },
  66.                     "large": {
  67.                         "url": "https://hag.huawei.com/1.jpg",
  68.                         "widthPixels": 280,
  69.                         "heightPixels": 280
  70.                     }
  71.                 },
  72.                 "position": 3
  73.             },
  74.             {
  75.                 "content": "加压20分钟后，泄压开盖，加入适量盐调味，即可盛出食用。",
  76.                 "image": {
  77.                     "small": {
  78.                         "url": "https://hag.huawei.com/1.jpg",
  79.                         "widthPixels": 72,
  80.                         "heightPixels": 72
  81.                     },
  82.                     "medium": {
  83.                         "url": "https://hag.huawei.com/1.jpg",
  84.                         "widthPixels": 172,
  85.                         "heightPixels": 172
  86.                     },
  87.                     "large": {
  88.                         "url": "https://hag.huawei.com/1.jpg",
  89.                         "widthPixels": 280,
  90.                         "heightPixels": 280
  91.                     }
  92.                 },
  93.                 "position": 12
  94.             }
  95.         ],
  96.         "tag": "肉类；驱寒暖身；下饭菜；晚餐；午餐；朋友聚餐；西北菜",
  97.         "textLiveLink": {
  98.             "webURL": "",
  99.             "deepLink": {
  100.                 "url": "demo://food/action?param1=xxx&param2=yyy",
  101.                 "appName": "demo",
  102.                 "appPackage": "com.demo.food",
  103.                 "minVersion": "",
  104.                 "minAndroidAPILevel": "23"
  105.             },
  106.             "quickApp": {
  107.                 "url": "hap://app/com.huawei.hag/demo/food",
  108.                 "minPlatformVersion": "",
  109.                 "minVersion": ""
  110.             }
  111.         },
  112.         "videoLiveLink": {
  113.             "webURL": "",
  114.             "deepLink": {
  115.                 "url": "demo://food/action?param1=xxx&param2=yyy",
  116.                 "appName": "demo",
  117.                 "appPackage": "com.demo.food",
  118.                 "minVersion": "",
  119.                 "minAndroidAPILevel": "23"
  120.             },
  121.             "quickApp": {
  122.                 "url": "hap://app/com.huawei.hag/demo/food",
  123.                 "minPlatformVersion": "",
  124.                 "minVersion": ""
  125.             }
  126.         },
  127.         "image": {
  128.             "small": {
  129.                 "url": "https://hag.huawei.com/1.jpg",
  130.                 "widthPixels": 72,
  131.                 "heightPixels": 72
  132.             },
  133.             "medium": {
  134.                 "url": "https://hag.huawei.com/1.jpg",
  135.                 "widthPixels": 172,
  136.                 "heightPixels": 172
  137.             },
  138.             "large": {
  139.                 "url": "https://hag.huawei.com/1.jpg",
  140.                 "widthPixels": 280,
  141.                 "heightPixels": 280
  142.             }
  143.         },
  144.         "status": "",
  145.         "cookMethod": "",
  146.         "cookTime": "30-45分钟",
  147.         "cookTimes": 9045,
  148.         "difficulty": "切墩(初级)",
  149.         "similarity": 0.98 "
  150.         "colltectionTimes": 3305,
  151.         "browseTimes": 10955
  152.     }]
  153. }

成员名称描述是否必选类型取值范围
items菜谱信息是RecipeInfoItem[]最大长度：16

1.3 结构

1.3.1 RecipeInfoItem

菜谱条目

成员名称描述是否必选类型取值范围
id菜谱词条Id（每一道菜对应一个id，根据搜索的id实现做菜步骤多轮交互功能。）是string最大长度：32
title菜名（如：红烧肉）是string最大长度：32
author菜谱作者否string最大长度：32
brief菜谱简介否string最大长度：256
ingredient主料列表是string[]最大Item数：50
accessory辅料列表是string[]最大Item数：50
steps步骤是string最大长度：1024
stepsWithImg步骤详情是RecipeInfoItemStep[]最大Item数：50
tag标签（如：下饭菜；晚餐；单身食谱；徽菜）否string最大长度：128
textLiveLink文本直播链接否Interaction/
videoLiveLink视频直播链接否Interaction/
image菜谱图片信息是ImageInfo[]最大Item数：256
status菜谱状态否string最大长度：64
cookMethod烹饪手法否string最大长度：128
cookTime烹饪时间（如：10-30分钟）否string最大长度：64
cookTimes多少人做过否long/
difficulty难度（如：切墩（初级））否string最大长度：64
similarity相似度，如：0.98否number/
collectionTimes收藏次数否long/
browseTimes浏览次数否long/

1.3.2 RecipeInfoItemStep

菜谱步骤

成员名称描述是否必选类型取值范围
position步骤序号 （例如：1、2、3）是long/
content步骤内容是string最大长度：512
image菜谱图片URL地址是ImageInfo/