唐诗宋词大全 API 接口
支持 40 万数据全文检索。
gugudata_api_cover1. 产品功能
-
中文全数量级唐诗宋诗宋词数据;
-
关键字可对标题、作者与内容进行模糊匹配;
-
总计近 40 万条数据;
-
数据持续更新与维护;
-
全接口支持 HTTPS(TLS v1.0 / v1.1 / v1.2 / v1.3);
-
全面兼容 Apple ATS;
-
全国多节点 CDN 部署;
-
接口极速响应,多台服务器构建 API 接口负载均衡。
2. API 文档
API 详情地址: https://www.gugudata.com/api/details/chinesepoem
接口请求地址: https://api.gugudata.com/text/chinesepoem
返回格式: application/json; charset=utf-8
请求方式: GET
请求协议: HTTPS
数据预览: https://www.gugudata.com/preview/chinesepoem
接口测试: https://api.gugudata.com/text/chinesepoem/demo
3. 请求参数(如果为 POST 请求,那么参数以 JSON 的格式传递)
参数名 | 参数类型 | 是否必须 | 默认值 | 备注 | ||
---|---|---|---|---|---|---|
appkey | string | 是 | YOUR_APPKEY | 付费后获取的 APPKEY | ||
keywords | string | 否 | YOUR_VALUE | 查询关键字,注意:所有数据都是中文繁体,在传递关键词检索时,请注意传递中文繁体字进行查询 | ||
pagesize | int | 是 | 10 | 分页参数,每页总条数,取值范围在 10 ~ 50 之间 | ||
pagenumber | int | 是 | 1 | 分页参数,第几页 | ||
type | string | 否 | 数据分类,可选参数为(tang, song, ci)。唐诗: tang | 宋诗: song | 宋词: ci,不传递或空值则不进行过滤 |
4. 返回参数
参数名 | 参数类型 | 备注 | ||
---|---|---|---|---|
DataStatus.StatusCode | int | 接口返回状态码 | ||
DataStatus.StatusDescription | string | 接口返回状态说明 | ||
DataStatus.ResponseDateTime | string | 接口数据返回时间 | ||
DataStatus.DataTotalCount | int | 此条件下的总数据量,一般用于分页计算 | ||
DataStatus.RequestParameter | string | 请求参数,一般用于调试 | ||
Data.Title | string | 诗歌标题或宋词词牌名 | ||
Data.Author | string | 作者名 | ||
Data.Content | string[] | 诗歌或词的内容,格式为 string 数组 | ||
Data.Type | string | 类型,分为:唐诗 | 宋诗 | 宋词 |
5. 接口响应状态码
错误码 | 错误内容 | 备注 |
---|---|---|
100 | 正常返回 | |
101 | 参数错误 | |
102 | 请求频率受限 | 每秒请求不能超过 100 次 |
103 | 账号欠费 | |
104 | APPKEY 错误 | 请检查传递的 APPKEY 是否为开发者中心获取到的值 |
110 | 接口响应错误 |
6. 开发语言请求示例代码
示例代码包含的开发语言:C#, Go, Java, jQuery, Node.js, Objective-C, PHP, Python, Ruby, Swift 等,其他语言进行对应的 RESTful API 请求实现即可。
示例代码截图
网友评论