API 文档
接口地址: https://api.gugudata.com/text/chinesepoem
返回格式: application/json; charset=utf-8
请求方式: GET
请求协议: HTTPS
请求示例: https://api.gugudata.com/text/chinesepoem?appkey=YOUR_APPKEY&keywords=YOUR_VALUE&pagesize=10&pagenumber=1&type=&searchtype=all
数据预览: https://www.gugudata.com/preview/chinesepoem
接口测试: https://api.gugudata.com/text/chinesepoem/demo
OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json
| 参数名 |
参数类型 |
是否必须 |
默认值 |
备注 |
| appkey |
string |
是 |
YOUR_APPKEY |
付费后获取的 APPKEY |
| keywords |
string |
否 |
YOUR_VALUE |
查询关键字,会模糊匹配标题、作者与内容,结果按照类别、作者进行排序。内容关键字传递中文简体、中文繁体都可兼容搜索 |
| pagesize |
integer |
是 |
10 |
分页参数,每页总条数,取值范围在 1 ~ 20 之间 |
| pagenumber |
integer |
是 |
1 |
分页参数,第几页 |
| type |
string |
否 |
|
数据分类,可选参数为(tang, song, ci)。唐诗: tang | 宋诗: song | 宋词: ci,不传递或空值则不进行过滤 |
| searchtype |
string |
否 |
all |
关键字条件匹配的内容,可选参数为(title, author, content, all)。标题或词牌名: title | 作者: author | 诗歌或词的内容: content | 匹配以上所有: all,不传递则默认值为 all |
| 参数名 |
参数类型 |
备注 |
| DataStatus.StatusCode |
integer |
接口返回状态码 |
| DataStatus.StatusDescription |
string |
接口返回状态说明 |
| DataStatus.ResponseDateTime |
string |
接口数据返回时间 |
| DataStatus.DataTotalCount |
integer |
此条件下的总数据量,一般用于分页计算 |
| DataStatus.RequestParameter |
string |
请求参数,一般用于调试 |
| Data.Title |
string |
诗歌标题或宋词词牌名 |
| Data.Author |
string |
作者名 |
| Data.Content |
array |
诗歌或词的内容,格式为 string 数组 |
| Data.Type |
string |
类型,分为:唐诗 | 宋诗 | 宋词 |