查询字词的书籍的释文数据
接口地址:/book/explain
请求方式:GET
响应数据类型:application/json
接口描述:
- 精确匹配查的字词,支持多本书的书籍ID传入,如果不传书籍ID会查询该客户端所有的书籍释文
- 接口返回的部分内容是乱码需要下载对应的字体包才能显示
- 获取字体令牌和字体名字默认是在响应头中需要传入
fontIn=body
才会在响应体中,并且返回json会变为一下内容{
"data": {
// 源数据
},
"font": {
"id":"字体的ID,通过这个ID可以直接下载字体包",
"name":"字体的名字",
"token":"字体的令牌",
}
} - 接口有限流所以不能调用太快
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
Authorization | 授权请求头 | header | true | string | |
x-jd-device | 设备信息 | header | false | string | |
q | 要搜索的字/词 | query | true | string | |
simplified | 是否同时搜索简体, false 不搜索,true搜索 | query | false | boolean | |
qualitative | 是否同时定性语, false 不搜索,true搜索 | query | false | boolean | |
maxSize | 结果的最大大小,最多支持100条数据 | query | false | integer(int32) | |
bookId | 需要搜索的书籍,为空搜索全部有权限的书籍 | query | false | array | integer |
synonym | 是否同时包含近义词搜索 false 不搜索,true 搜索 | query | false | boolean |
响应状态:
状态码 | 说明 | schema |
---|---|---|
200 | OK | object |
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
entries | 释文列表 | array | object |
id | integer(int64) | ||
headword | 词头 | string | |
xml | 释文xml | string | |
bookName | 书籍名字 | string | |
simplified | 简体 | string | |
qualitatives | 定性语列表 | array | Qualitative |
headword | 词头 | string | |
name | 定性语名字 | string | |
qualitative | 定性语 | integer(int32) | |
entryType | 词头类型,可用值:WORDS,ENCYCLOPEDIA,EPOCH,PLACE_NAME,ENGLISH,Synonym,CHINESE_ENGLISH | string | |
spell | 拼音 | string |
响应示例:
{
"entries": [
{
"id": 0,
"headword": "",
"xml": "",
"bookName": "",
"simplified": ""
}
],
"qualitatives": [
{
"headword": "",
"name": "",
"qualitative": 0,
"entryType": "",
"spell": ""
}
]
}