API 文档
接口地址: https://api.gugudata.com/websitetools/readability
返回格式: application/json; charset=utf-8
请求方式: POST
请求协议: HTTPS
请求示例: https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY
HTML 输入示例:未提供 URL 时使用以下 HTML;同时提供时优先处理 URL。
{"html":"<html lang='zh'><head><title>文章整理示例</title></head><body><article><h1>文章整理示例</h1><p>整理项目自有文章,保留正文内容,便于阅读和归档。</p></article></body></html>"}
数据预览: https://www.gugudata.com/preview/readability
接口测试: https://api.gugudata.com/websitetools/readability/demo
OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json
请求参数(POST 请求参数以 application/x-www-form-urlencoded 格式、文件流以 formdata 格式传递,具体可参见下方示例代码)
| 参数名 |
参数类型 |
是否必须 |
默认值 |
备注 |
| appkey |
string |
是 |
无 |
开发者中心分配的 APPKEY;支持现有 Query、Body、Header 和 Bearer 鉴权。 |
| url |
string |
否 |
无 |
公开 HTTP/HTTPS 网页地址;url 与 html 至少一项为非空字符串,同时提供时优先使用 URL,URL 无效时不转用 HTML。 |
| html |
string |
否 |
无 |
待抽取的 HTML 字符串;未提供 URL 时使用,不执行其中的脚本。支持表单和 JSON。 |
| 参数名 |
参数类型 |
备注 |
| DataStatus.RequestParameter |
string |
本次实际业务请求参数,不包含鉴权凭据;Demo 展示对应样例输入。 |
| DataStatus.StatusCode |
integer |
成功业务码为 100;错误码见说明。 |
| DataStatus.StatusDescription |
string |
接口返回状态说明。 |
| DataStatus.ResponseDateTime |
string |
接口数据返回时间。 |
| DataStatus.DataTotalCount |
integer |
成功返回一个正文对象,值为 1。 |
| Data.Title |
string |
识别到的标题;缺失时为空。 |
| Data.Byline |
string |
作者信息;缺失时为空。 |
| Data.Dir |
string |
文字方向;缺失时为空。 |
| Data.Lang |
string |
页面语言;缺失时为空。 |
| Data.Content |
string |
正文 HTML,作为文本返回。 |
| Data.TextContent |
string |
正文纯文本;降级时最多 50,000 个 UTF-16 代码单元。 |
| Data.Length |
integer |
返回纯文本的 UTF-16 代码单元数。 |
| Data.Excerpt |
string |
内容摘要;缺失时为空。 |
| Data.SiteName |
string |
站点名称;缺失时为空。 |
| Data.PublishedTime |
string |
识别到的发布时间,可能为空;缺失时为空。 |