接入文档
接口简介
本接口用于获取标准化的菜谱分类列表。通过 POST 请求调用,系统将返回包含各类别名称的字符串数组(如“鸽子”、“川菜”等),帮助开发者快速建立内容索引基础。
适用场景
- 内容管理系统:为美食博客或 APP 提供初始分类标签库。
- 搜索筛选优化:构建前端筛选器的分类选项,提升用户检索效率。
- 数据标准化:统一不同来源菜谱数据的分类口径,便于后续数据分析。
请求与返回说明
- 请求方式:POST
- 请求路径:
/v1/cookbook-type - 输入参数:当前版本无需特定业务参数,直接发起请求即可获取全量或默认分类集。
- 返回结构:JSON 数组,元素为字符串类型。例如
["鸽子", "家常菜"],每个元素代表一个具体的分类名称。
接入建议
- 缓存策略:由于分类数据相对稳定,建议前端或服务端进行本地缓存(如 TTL 设置为 24 小时),减少不必要的 API 调用。
- 异常处理:请妥善处理网络超时或空数组返回的情况,确保前端展示兜底逻辑。
- 数据映射:返回的分类名称可能需与内部数据库 ID 进行映射,建议在接入初期建立对照表。
接入示例代码
提供 Shell、Python、Go、Java、PHP 等常见接入示例,便于直接接到现有项目里。
请求示例
{}响应示例
[
"鸽子"
]请求字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 示例值 |
|---|---|---|
| type | string | object |
| properties | object | {...} |
响应字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 示例值 |
|---|---|---|
| type | string | array |
| items | object | {...} |
| items.type | string | string |
| items.example | string | 鸽子 |
| example | array | "鸽子" |
| example[] | string | 鸽子 |