POSTcookbook-list
レシピ検索
レシピ検索
導入ドキュメント
インターフェースの紹介
このインターフェイスは、構造化されたレシピ データ クエリ サービスを提供します。開発者は、料理のカテゴリ (第 1 レベルから第 3 レベルのカテゴリをサポート)、料理名、または一意の ID を指定して検索できます。このインターフェイスは、料理名、分類レベル、サムネイル、必要な材料リスト、ステップバイステップの調理ガイドを含む完全なデータ構造を返します。詳細なレシピ情報を表示する必要があるビジネスシーンに適しています。
該当するシナリオ
- グルメ APP/Web サイト: サイトのレシピ ライブラリを充実させ、標準化された料理チュートリアルを提供します。
- スマート ハードウェア統合: スマート キッチン家電や調理ロボットに標準化された指示ステップ データを提供します。
- コンテンツ集約プラットフォーム: 垂直方向の食品コンテンツ セクションを迅速に構築し、肉や野菜などのディメンションによるフィルタリングをサポートします。
リクエストと返品の手順
- リクエスト方法: POST
- コアパラメータ:
type(必須): レシピ分類。第 1 レベルまたは第 2 レベルの分類タグを使用することをお勧めします。name(オプション): 料理名のあいまい検索。id(オプション): 単一アイテムの詳細を取得するには、レシピ ID を指定します。pageNo/pageSize: ページング データを制御します。デフォルトは 1 ページあたり 20 項目です。- 結果を返す:
・基本情報:料理名、多段分類タグ、作成時刻。
- マルチメディア リソース: 小さな画像 (
smallImag) と大きな画像 (largeImg) へのリンク。 - コアコンテンツ:
yl配列には原材料名と単位が含まれます。steps配列には、操作ステップの順序付けされたテキストが含まれます。
提案へのアクセス
- キャッシュ戦略: レシピ データは比較的静的です。 API 呼び出しの頻度を減らすために、人気のあるカテゴリまたは特定の ID の結果をローカルにキャッシュすることをお勧めします。
- 画像処理: 返された画像の 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 |