本文档提供了妙搜在接入三方企业搜索服务时所遵循的API规范。
请求规范
端点与方法
- 协议：HTTP(S)
-
方法：
- POST
请求头
- Content-Type: application/json
鉴权
妙搜通过HTTP Header中的Authorization字段传递鉴权信息，支持以下格式：
Authorization: Basic ${BasicToken}Authorization: Bearer ${BasicToken}
请求体
请求体采用application/json格式，参数说明如下：
字段名 | 字段类型 | 是否必填 | 字段描述 | 字段示例值 |
|---|---|---|---|---|
query | String | 是 | 搜索关键字 | "杭州亚运会" |
current | Integer | 否 | 当前页码 默认值：1 | 1 |
size | Integer | 否 | 每页返回的数据条数 默认值：20 | 20 |
includeContent | Boolean | 否 | 是否返回正文内容 默认值：true | true |
响应规范
响应头
Content-Type: application/json
响应体
响应体采用application/json格式，结构如下：
字段名 | 字段类型 | 字段描述 | 字段示例值 |
|---|---|---|---|
success | Boolean | 请求是否成功 | true |
code | String | 错误码，请求失败时返回 | "PARAM_ERROR" |
message | String | 错误信息，请求失败时返回 | "参数错误" |
data | List | 搜索结果数据列表，具体结构见下文 Article 对象 | [] |
current | Integer | 当前页码 | 1 |
size | Integer | 每页返回的数据条数 | 20 |
total | Integer | 匹配到的总条数 | 100 |
Article 对象
响应体data字段是一个列表，列表中的每个元素都是一个 Article 对象，其结构如下：
字段名 | 字段类型 | 是否必填 | 字段描述 | 字段示例值 |
|---|---|---|---|---|
source | String | 是 | 文章来源 | "央视网" |
title | String | 是 | 文章标题 | "杭州亚运会" |
content | String | 是 | 文章正文。如果请求参数 | "无论是“大莲花”“小莲花”“大玉琮”“杭州伞”等场馆造型..." |
url | String | 是 | 文章原文链接 | |
summary | String | 否 | 文章摘要。如果原始数据无此字段，可截取正文前N个字符作为摘要。 | "摘要内容..." |
pubTime | String | 是 | 文章发布时间，格式：yyyy-MM-dd HH:mm:ss | "2023-01-01 12:01:01" |