查询字词的内容数据
接口地址:/content
请求方式:GET
响应数据类型:application/json
接口描述:
- 接口返回的部分内容是乱码需要下载对应的字体包才能显示
- 获取字体令牌和字体名字默认是在响应头中,需要传入在请求的参数加上
fontIn=body
才会在响应体中,加了这个参数会导致返回的json会变为以下内容{
"data": {
// 源数据
},
"font": {
"id":"字体的ID,通过这个ID可以直接下载字体包",
"name":"字体的名字",
"token":"字体的令牌",
}
} - 如果没有返回field字段的话json对象是直接 没有这个key而不是会返回null
- 默认使用错词纠错,如果不需要使用纠错请传入
useCorrect=false
- 如果纠错成功会返回 correctWord 字段,如果没有纠错则不会返回
- 如果不传 fields 默认只查询释文和基本信息,但是如果没有释文则会从其它索引中获取
- 如果不想只加载释文信息需要查询所有功能数据,请直接指定 fields,但是这样可能会影响接口的性能,因为如果传入所有的会导致接口变慢
- 接口有限流所以不能调用太快
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
q | 要查询的文字 | query | true | string | |
Authorization | 授权请求头 | header | true | string | |
fields | 要查询的功能,逗号分隔 eg: shiwen.danzi,shiwen.baike,shici | query | false | array | string |
useCorrect | 是否使用自动纠错,true使用,false不使用 | query | false | boolean | |
fontIn | 字体信息是否在响应体中 | query | false | ||
x-jd-device | 设备信息 | header | false | string |
响应状态:
状态码 | 说明 | schema |
---|---|---|
200 | OK | object |
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
fields | 字段信息 | object | |
query | 搜索的原始文字 | string | |
correctWord | 纠错后的文字 | string | |
info | object | ||
fields | 字段信息 | object | |
danzi | 单字 | object | |
radical | 部首 | string | |
strokes | 笔画数 | integer(int32) | |
strokeGif | object | ||
white | 标准笔顺gif | string | |
black | 反色笔顺gif | string | |
level | 字级 | string | |
wordNum | 编码 | string | |
spell | 拼音 | string | |
chapterOrder | 笔顺 | string | |
category | 分类 | string | |
structure | 结构 | string | |
lazyFields | 懒加载字段 | array | |
shiwen | object | ||
danzi | 单字 | string | |
yuci | 语词 | string | |
baike | 百科 | string | |
fields | 字段信息 | object | |
shufa | 书法 | object | |
yuanliu | 源流 | object | |
shici | 唐诗宋词 | array | object |
name | 诗词名 | string | |
brandName | 词牌说明 | string | |
wordOrder | 词序 | string | |
content | 正文 | string | |
annotation | 注释 | string | |
appreciation | 赏析 | string | |
appreciationAuthor | 赏析作者 | string | |
bookName | 书籍名 | string | |
author | 作者小传 | object | |
name | 作者姓名 | string | |
brief | 小传内容 | string | |
tongyici | 同义词 | array | |
jinyici | 近义词 | array | |
fanyici | 反义词 | array |
响应示例:
{
"fields": {},
"query": "",
"correctWord": "",
"info": {
"fields": {},
"danzi": {
"radical": "",
"strokes": 0,
"strokeGif": {
"white": "",
"black": ""
},
"level": "",
"wordNum": "",
"spell": "",
"chapterOrder": "",
"category": "",
"structure": ""
}
},
"lazyFields": [],
"shiwen": {
"danzi": "",
"yuci": "",
"baike": "",
"fields": {}
},
"shufa": {},
"yuanliu": {},
"shici": [
{
"name": "",
"brandName": "",
"wordOrder": "",
"content": "",
"annotation": "",
"appreciation": "",
"appreciationAuthor": "",
"bookName": "",
"author": {
"name": "",
"brief": ""
}
}
],
"tongyici": [],
"jinyici": [],
"fanyici": []
}