API 概述
智能检索
支持多维度分类检索,包含舌象、苔象、脉象、体质四大分类,精准匹配适用茶饮
权威数据库
基于传统中医理论构建,包含数千种经典茶饮配方,功效明确,用法详实
多端支持
RESTful API 设计,支持各种编程语言和平台,轻松集成到您的应用中
接口文档
GET
/api/herbal-food/search
茶饮检索接口,支持分类筛选和关键词搜索
分类参数
适用舌象
红舌
瘦薄舌
嫩舌
嫩舌
适用苔象
白苔
黄苔
薄苔
厚苔
适用脉象
平脉
浮脉
沉脉
数脉
适用体质
平和质
气虚质
阳虚质
阴虚质
搜索参数
| 参数名 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| apiKey | string | 是 | API 密钥 | your_api_key_here |
| appKey | string | 是 | 应用标识 | your_app_key_here |
| keyword | string | 否 | 茶饮名称关键词 | 补气 |
| tongue | array | 否 | 适用舌象数组 | ["淡红舌", "红舌"] |
| coating | array | 否 | 适用苔象数组 | ["白苔", "薄苔"] |
| pulse | array | 否 | 适用脉象数组 | ["平脉", "浮脉"] |
| constitution | array | 否 | 适用体质数组 | ["平和质", "气虚质"] |
| page | number | 否 | 页码(默认1) | 1 |
| limit | number | 否 | 每页数量(默认10) | 20 |
返回数据结构
| 字段名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| code | number | 状态码 | 200 |
| message | string | 状态信息 | "success" |
| data | object | 返回数据 | {} |
| data.total | number | 总记录数 | 156 |
| data.list | array | 茶饮列表 | [] |
| data.list[].id | number | 茶饮编号 | 1001 |
| data.list[].name | string | 茶饮名称 | "四物汤" |
| data.list[].ingredients | string | 茶饮材料 | "当归、川芎、白芍、熟地黄" |
| data.list[].method | string | 制作方法 | "将药材洗净,加水煎煮两次,合并药汁..." |
| data.list[].effect | string | 茶饮功效 | "补血调经,养血安神" |
| data.list[].contraindication | string | 使用禁忌 | "孕妇慎用,感冒期间暂停服用" |
| data.list[].tongue | array | 适用舌象 | ["淡白舌", "无华舌"] |
| data.list[].coating | array | 适用苔象 | ["薄苔", "白苔"] |
| data.list[].pulse | array | 适用脉象 | ["细脉", "弱脉"] |
| data.list[].constitution | array | 适用体质 | ["血虚质", "阴虚质"] |
| data.list[].image_url | string | 图片URL | "https://images.unsplash.com/photo-1556909114-f6e7ad7d3136" |
调用示例
JavaScript 示例
// 引入必要的库
import axios from 'axios';
// 配置API密钥
const API_KEY = 'your_api_key_here';
const APP_KEY = 'your_app_key_here';
// 检索参数
const params = {
apiKey: API_KEY,
appKey: APP_KEY,
keyword: '补气', // 搜索关键词
tongue: ['淡白舌', '胖嫩舌'], // 适用舌象
constitution: ['气虚质'], // 适用体质
page: 1,
limit: 10
};
// 发起API请求
axios.get('https://api.example.com/api/herbal-food/search', {
params: params
})
.then(response => {
const data = response.data;
if (data.code === 200) {
console.log('检索结果:', data.data.list);
console.log('总记录数:', data.data.total);
} else {
console.error('错误:', data.message);
}
})
.catch(error => {
console.error('请求错误:', error);
});
Python 示例
import requests
# API配置
API_KEY = 'your_api_key_here'
APP_KEY = 'your_app_key_here'
# 检索参数
params = {
'apiKey': API_KEY,
'appKey': APP_KEY,
'keyword': '补血', # 搜索关键词
'pulse': ['细脉', '弱脉'], # 适用脉象
'constitution': ['血虚质'], # 适用体质
'page': 1,
'limit': 15
}
# 发起请求
response = requests.get('https://api.example.com/api/herbal-food/search', params=params)
# 处理响应
if response.status_code == 200:
data = response.json()
if data['code'] == 200:
print('检索结果:', data['data']['list'])
print('总记录数:', data['data']['total'])
else:
print('错误:', data['message'])
else:
print('请求失败:', response.status_code)
错误码说明
200
成功
请求成功,返回正常数据
400
参数错误
缺少必填参数或参数格式不正确
401
认证失败
API密钥或应用标识不正确
404
资源不存在
请求的接口不存在
500
服务器错误
服务器内部错误,请稍后重试
503
服务不可用
服务暂时不可用,请稍后重试