相关查询与相关内容 API

本页介绍用于获取查询相关信息的两个端点。

• GET /related-queries — 获取针对查询的相关查询候选。

• GET /related-content — 获取针对查询的相关 HTML 内容。

上述两个端点的结果均基于管理员预先注册的相关查询及相关内容设置。当没有匹配的设置时，将返回空结果。

有关公共响应信封及错误模型，请参阅 API 概述。

获取相关查询

请求

HTTP 方法	GET
端点	/api/v2/related-queries

向 Fess 发送 http://<Server Name>/api/v2/related-queries?q=fess 等形式的请求，可以获取针对指定查询的相关查询词列表（JSON 格式）。

请求的搜索词将与已注册的相关查询设置进行不区分大小写的匹配。 即使 q 为空或未指定，也不会报错，而是返回空的 queries 数组。响应始终为成功信封。

请求参数

请求参数

q	用于获取相关查询的搜索词。（例）q=fess

响应

成功时，返回如下公共信封格式的响应。

{
  "response": {
    "status": 0,
    "queries": [
      "fess search",
      "fess install"
    ]
  }
}

response 各元素说明如下。

响应信息

queries

相关查询词的数组（字符串数组）。q 为空或未指定时，或没有匹配的设置时，返回空数组。

使用示例

使用 curl 命令的请求示例：

curl "http://localhost:8080/api/v2/related-queries?q=fess"

错误响应

错误响应

状态码	说明
405 Method Not Allowed	指定了不支持的 HTTP 方法时。Allow 头中会指示 GET。
500 Internal Server Error	发生服务器内部错误时。

获取相关内容

请求

HTTP 方法	GET
端点	/api/v2/related-content

向 Fess 发送 http://<Server Name>/api/v2/related-content?q=fess 等形式的请求，可以获取针对指定查询的相关 HTML 内容（JSON 格式）。

请求的搜索词将与已注册的相关内容设置进行匹配。当多个内容项匹配时，将以换行符连接。 即使 q 为空或未指定，也不会报错，而是返回空字符串的 content。响应始终为成功信封。

请求参数

请求参数

q	用于获取相关内容的搜索词。（例）q=fess

响应

成功时，返回如下公共信封格式的响应。

{
  "response": {
    "status": 0,
    "content": "<div>...相关 HTML 内容...</div>",
    "content_type": "html"
  }
}

response 各元素说明如下。

响应信息

content	相关 HTML 内容（字符串）。多个项目匹配时以换行符连接。q 为空或未指定时，或没有匹配的设置时，返回空字符串。
content_type	内容类型。值始终为 html。

使用示例

使用 curl 命令的请求示例：

curl "http://localhost:8080/api/v2/related-content?q=fess"

错误响应

错误响应

状态码	说明
405 Method Not Allowed	指定了不支持的 HTTP 方法时。Allow 头中会指示 GET。
500 Internal Server Error	发生服务器内部错误时。