智能小程序 Ray 开发菜谱 API ——自定义食谱 API 接口汇总

获取自定义食谱列表功能

getCustomRecipeList

引入

@ray-js/ray^1.5.0 以上版本可使用

import { getCustomRecipeList } from '@ray-js/ray';

参数

GetCustomRecipeListParams

属性	类型	说明
query	CustomRecipeQuery	查询条件
devId	string	设备 ID

CustomRecipeQuery

属性	类型	说明
pageNo	number	分页页号，默认为 0
pageSize	number	分页大小，默认为 10

返回

GetCustomRecipeListResponse

CustomRecipeListResult，自定义食谱列表返回结果。

CustomRecipeListResult

属性	类型	说明
totalCount	number	总记录条数
pageNo	number	分页页号
pageSize	number	分页大小
hasNext	boolean	是否还有下一页
data	CustomRecipeInfo[]	食谱信息数组

CustomRecipeInfo

属性	类型	说明
id	number	食谱 ID
mainImgs	string[]	主图数组
lang	number	语言
langDesc	string	语言信息
cookType	number	烹饪类型
sourceType	number	食谱类型
name	string	食谱名称
gmtCreate	number	创建时间戳
gmtModified	number	修改时间戳

函数定义示例

/**
 * 获取自定义食谱列表
 */
export const getCustomRecipeList: (
  params: GetCustomRecipeListParams
) => Promise<GetCustomRecipeListResponse>;

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。  

自定义食谱添加功能

addCustomRecipe

引入

@ray-js/ray^1.5.0 以上版本可使用

import { addCustomRecipe } from '@ray-js/ray';

参数

AddCustomRecipeParams

属性	类型	说明
menuCustom	MenuCustomInfo	食谱信息
devId	string	设备 ID

MenuCustomInfo

属性	类型	可选性	说明
mainImages	string[]	必须	主图数组
name	string	必须	食谱名称
desc	string	可选	食谱简介
productGroupId	string	必须	产品组 ID
isPublish	number	可选	是否公开
cookType	number	必须	烹饪类型
foods	string	可选	食材
information	string	可选	相关常识
xyxk	string	可选	相宜相克
cookTime	number	可选	烹饪时间
stepInfoParams	StepInfoParam[]	必须	图文步骤
cookStepParams	CookStepParam[]	必须	烹饪步骤信息
customProperties	CustomPropertiesItem[]	可选	自定义属性 @ray-js/ray^1.5.5 新增

CustomPropertiesItem

字段	类型	可选性	描述
bizCode	string	必须	自定义属性 code
name	string	必须	自定义属性名称
desc	string	必须	自定义属性内容
fileUrl	string	必须	自定义属性文件 URL
bizOrder	string	必须	自定义属性排序

StepInfoParam

字段	类型	可选性	描述
stepImg	string	可选	步骤图片路径
desc	string	必须	步骤描述

CookStepParam

字段	类型	可选性	描述
step	number	必须	步骤序号
stepImg	string	可选	步骤详图
desc	string	可选	步骤描述信息
finishCtrl	string	必须	完成执行选项
cookArgs	CookArg[]	必须	烹饪参数数组

CookArg

字段	类型	可选性	描述
dpCode	string	必须	DP Code
dpValue	string	必须	DP 值

返回

AddCustomRecipeResponse

boolean，添加成功与否的返回结果。

函数定义示例

/**
 * 自定义食谱添加
 */
export const addCustomRecipe: (params: AddCustomRecipeParams) => Promise<AddCustomRecipeResponse>;

自定义食谱更新功能

updateCustomRecipe

引入

@ray-js/ray^1.5.0 以上版本可使用

import { updateCustomRecipe } from '@ray-js/ray';

参数

UpdateCustomRecipeParams

属性	类型	说明
menuCustom	UpdateMenuCustomInfo	食谱信息
devId	string	设备 ID

UpdateMenuCustomInfo

属性	类型	可选性	说明
id	number	必须	食谱 ID
mainImages	string[]	必须	主图数组
name	string	必须	食谱名称
desc	string	可选	食谱简介
productGroupId	string	必须	产品组 ID
isPublish	number	可选	是否公开
cookType	number	必须	烹饪类型
foods	string	可选	食材
information	string	可选	相关常识
xyxk	string	可选	相宜相克
cookTime	number	可选	烹饪时间
stepInfoParams	StepInfoParam[]	必须	图文步骤
cookStepParams	CookStepParam[]	必须	烹饪步骤信息
customProperties	CustomPropertiesItem[]	可选	自定义属性 @ray-js/ray^1.5.5 新增

CustomPropertiesItem

字段	类型	可选性	描述
bizCode	string	必须	自定义属性 code
name	string	必须	自定义属性名称
desc	string	必须	自定义属性内容
fileUrl	string	必须	自定义属性文件 URL
bizOrder	string	必须	自定义属性排序

UpdateStepInfoParam

字段	类型	可选性	描述
step	number	必须	步骤
stepImg	string	可选	步骤图片路径
desc	string	必须	步骤描述

UpdateCookStepParam

字段	类型	可选性	描述
step	number	必须	步骤序号
stepImg	string	可选	步骤详图
desc	string	可选	步骤描述信息
finishCtrl	string	必须	完成执行选项
cookArgs	CookArg[]	必须	烹饪参数数组

CookArg

字段	类型	可选性	描述
dpCode	string	必须	DP Code
dpValue	string	必须	DP 值

返回

UpdateCustomRecipeResponse

boolean，更新成功与否的返回结果。

函数定义示例

/**
 * 自定义食谱更新
 */
export const updateCustomRecipe: (
  params: UpdateCustomRecipeParams
) => Promise<UpdateCustomRecipeResponse>;

自定义食谱删除功能

deleteCustomRecipe

引入

@ray-js/ray^1.5.0 以上版本可使用

import { deleteCustomRecipe } from '@ray-js/ray';

参数

DeleteCustomRecipeParams

属性	类型	说明
menuId	number	食谱 ID

返回

DeleteCustomRecipeResponse

boolean，删除成功与否的返回结果。

函数定义示例

/**
 * 删除自定义食谱
 */
export const deleteCustomRecipe: (
  params: DeleteCustomRecipeParams
) => Promise<DeleteCustomRecipeResponse>;

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。