跳到主要内容
版本:v1

诗词作品搜索

接口地址:/

请求方式:GET

响应数据类型:application/json

接口描述:

  1. 支持标签需要搜索的标签,支持多个大的标签,每个大的标签就是一个数组,里面的小标签使用逗号分割,格式为 tags=tag1,tag2&tags=tag3,tag4,
  2. 诗人Id,
  3. 赏析作者Id,
  4. 根据关键字全文搜索诗词,支持传入fields参数搜索条件,不传则检索所有字段。 支持字段:
    1. name 诗词名字
    2. brandName 词牌
    3. poetry 诗文正文
    4. explain 译文
    5. appreciation 赏析 5、默认使用 spell 拼音正序排序,同时还支持 viewTimes 浏览次数排序

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
tags多标签搜索queryfalsestring
appreciationAuthorId鉴赏作者Idqueryfalsearraystring
poetryAuthorId诗人Idqueryfalsearraystring
q搜索词queryfalsestring
fields指定字段检索queryfalsearraystring
page页码queryfalseinteger
size页面的大小queryfalseinteger
sort排序标准的格式为:property,(ascdesc)。默认排序顺序为升序。支持多种排序标准queryfalsearray

响应状态:

状态码说明schema
200OKobject

响应参数:

参数名称参数说明类型schema
totalElementsinteger(int64)integer(int64)
totalPagesinteger(int32)integer(int32)
sizeinteger(int32)integer(int32)
contentarrayobject
  contentobject
    id诗词idstring
    title标题string
    name诗词名string
    brandName词牌名string
    preface词序string
    author诗人string
    authorId诗人Idstring
    dynasty诗词朝代string
    poetry内容string
    tags标签arraystring
    annotation注释string
    audio音频string
  highlights高亮内容object
numberinteger(int32)integer(int32)
firstboolean
lastboolean
numberOfElementsinteger(int32)integer(int32)
pageablePageableObjectPageableObject
  offsetinteger(int64)
  pagedboolean
  pageSizeinteger(int32)
  pageNumberinteger(int32)
  unpagedboolean
emptyboolean

响应示例:

{
"totalElements": 0,
"totalPages": 0,
"size": 0,
"content": [
{
"content": {
"id": "",
"title": "",
"name": "",
"brandName": "",
"preface": "",
"author": "",
"authorId": "",
"dynasty": "",
"poetry": "",
"tags": [],
"annotation": "",
"audio": ""
},
"highlights": {}
}
],
"number": 0,
"first": true,
"last": true,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"paged": true,
"pageSize": 0,
"pageNumber": 0,
"unpaged": true
},
"empty": true
}