文档

三方搜索API模板

更新时间:

三方搜索API模板,妙搜接入三方API时,推荐的API输入参数格式。

请求信息

  • 协议:HTTP(S)

  • header

    • Request Method:POST

    • Content-Type: application/json

  • 鉴权

    • Authorization:{{鉴权信息}}

    • 例如:

      • Authorization: Basic ${BasicToken}

      • Authorization: Bearer ${BasicToken}

请求参数

字段名

字段类型

是否必填

字段描述

字段示例值

query

String

搜索关键字

杭州亚运会

current

Integer

当前页:默认1

1

size

Integer

返回数据条数:默认20

20

includeContent

Boolean

是否包含正文:默认true

true

响应信息

  • header

  • Content-Type: application/json

响应参数

字段名

字段类型

字段描述

字段示例值

success

Boolean

请求是否成功

true

code

String

响应码:请求失败时返回的响应码

Error

message

String

响应错误信息

内部错误

data

List<Article>

文章数据

current

Integer

当前页

1

size

Integer

返回数据条数

20

total

Integer

总条数

100

Article

字段名

字段类型

是否必须

字段描述

字段示例值

source

String

文章来源

央视网

title

String

文章标题

杭州亚运会

content

String

文章内容

无论是“大莲花”“小莲花”“大玉琮”“杭州伞”等场馆造型。

url

String

文章URL

http://news.cctv.com/2023/08/29/ARTIZeHbELfOWLgviHk1IxGb230829.shtml

summary

String

文章摘要

如无,取前n字

pubTime

String

文章发布时间

2023-01-01 12:01:01

示例

请求

curl -X POST --location '{{url}}' \
    -H 'Authorization: basic {{BasicToken}}' \
    -H 'Content-Type: application/json' \
    -d '{
          "query": "杭州亚运会"
        }'

响应

{
  "success": true,
  "code": "",
  "message": "",
  "data": [
    "source": "",
    "title": "",
    "content": "",
    "url": "",
    "summary": "摘要",
    "pubTime": "2023-01-01 12:01:01"
  ]
}