接入文件
介面簡介
本介面提供結構化的菜譜資料查詢服務。開發者可透過指定菜品分類(支援一級至三級分類)、菜品名稱或唯一ID進行檢索。介面返回包含菜名、分類層級、縮圖、所需原料列表以及分步烹飪指南在內的完整資料結構,適用於需要展示詳細食譜資訊的業務場景。
適用場景
- 美食類APP/網站:豐富站內菜譜庫,提供標準化的做菜教程。
- 智慧硬體整合:為智慧廚電、烹飪機器人提供標準化的指令步驟資料。
- 內容聚合平臺:快速構建垂直領域的飲食內容板塊,支援按肉類、蔬菜等維度篩選。
請求與返回說明
- 請求方式:POST
- 核心引數:
type(必填):菜譜分類,建議使用一級或二級分類標籤。name(選填):模糊搜尋菜品名稱。id(選填):指定菜譜ID獲取單條詳情。pageNo/pageSize:控制分頁資料,預設每頁20條。- 返回結果:
- 基礎資訊:菜名、多級分類標籤、建立時間。
- 多媒體資源:小圖(
smallImag)與大圖(largeImg)連結。 - 核心內容:
yl陣列包含原料名稱與單位;steps陣列包含有序的操作步驟文字。
接入建議
- 快取策略:菜譜資料相對靜態,建議對熱門分類或特定ID的結果進行本地快取,減少API呼叫頻次。
- 圖片處理:返回的圖片URL可能為空,前端需做好預設圖適配。
- 分頁邏輯:首次載入可請求第一頁,根據返回的
totalPage實現懶載入或分頁器,避免一次性拉取大量資料。
接入示例程式碼
提供 Shell、Python、Go、Java、PHP 等常見接入示例,便於直接接到現有專案裡。
請求示例
{
"type": "菜谱的分类(查询时请使用分类中的一级或二级分类)",
"pageNo": "请求页数 默认第1页",
"pageSize": "每页返回的最大结果集,默认20",
"id": "菜谱标识 菜谱列表中id,可以用id查询详细",
"name": "菜品名称"
}響應示例
{
"code": 200,
"msg": "成功",
"taskNo": "025008804237815320489132",
"data": {
"totalPage": 61,
"pageNo": 1,
"pageSize": 20,
"totalCount": 1214,
"items": [
{
"type": "肉类 兔肉 兔肉",
"typeV1": "肉类",
"typeV2": "兔肉",
"typeV3": "兔肉",
"name": "泰顺腊兔肉",
"desc": "",
"tip": "",
"id": "5c4c75b3e9b6cc139e5dd87a",
"createTime": "2019-01-26 22:58:59.575",
"smallImag": "",
"largeImg": "",
"steps": [
{
"orderNum": 1,
"content": "腊兔肉切好,锅里放多油,油热后放入腊兔肉爆炒一会儿,然后放入姜蒜葱白胡萝卜爆香!炒之前用料酒酱油盐鸡精白糖调好的汁倒入锅中,等入味了就可以放葱香菜起锅了!"
}
],
"yl": [
{
"ylUnit": "胡萝卜",
"ylName": "泰顺腊兔子"
},
{
"ylUnit": "姜",
"ylName": "葱"
},
{
"ylUnit": "香菜",
"ylName": "蒜"
}
]
}
]
}
}請求欄位
以下欄位根據示例 JSON 自動提取,僅作接入參考。
| 欄位路徑 | 型別 | 示例值 |
|---|---|---|
| type | string | object |
| properties | object | {...} |
| properties.type | object | {...} |
| properties.type.type | string | string |
| properties.type.description | string | 菜谱的分类(查询时请使用分类中的一级或二级分类) |
| properties.pageNo | object | {...} |
| properties.pageNo.type | string | string |
響應欄位
以下欄位根據示例 JSON 自動提取,僅作接入參考。
| 欄位路徑 | 型別 | 示例值 |
|---|---|---|
| type | string | object |
| properties | object | {...} |
| properties.code | object | {...} |
| properties.code.type | string | number |
| properties.code.example | number | 200 |
| properties.msg | object | {...} |
| properties.msg.type | string | string |
| properties.msg.example |