开发者平台

搜索文档

GET /apiv2/posts/search.json?query={keyword}&sort={sort}&forum_id=&category_id=

搜索标题中包含keyword的文档

调用权限

all users

请求参数

query：搜索关键字，必填

sort：自定义搜索结果排序规则，可选，格式为：'排序字段:排序方式'，支持的排序字段：id(ID), created_at(创建时间), updated_at(更新时间), is_top(是否置顶), count_view(浏览数), count_comments(评论数), sort(排序序号)，支持的排序方式：asc(升序), desc(降序)

forum_id: 文档分类, 可选

category_id: 文档分区, 可选

curl示例

curl https://{subdomain}.kf5.com/apiv2/posts/search.json?query={keyword} \
 -v -u {email_address}:{password}

curl https://{subdomain}.kf5.com/apiv2/posts/search.json?query={keyword}&sort=sort:desc,created_at:asc \
 -v -u {email_address}:{password}

返回示例

Status: 200 OK{
  "posts": [
    {
      "id":   421,
      "title": "代理指南样本的测试",
      ...    },
    {
      "id":   425,
      "title": "帮助指南",
      ...    }
  ]}