获取内容列表

接口

GET /hserve/v2.2/content/detail/

该接口支持通过参数 return_total_count 指定是否返回查询对象总数，以协助不关心对象总数只关心查询结果列表的开发者提升接口响应速度。同时，从 v2.2 版本开始该接口默认不返回查询对象总数，欲获取总数的开发者需要显式指定 return_total_count 参数。

请求参数

  • where 查询语句
  • order_by 排序字段
  • return_total_count 指定是否在返回结果 meta 中返回 total_count

以下参数需二选一可选：

  • category_id 分类 ID
  • content_group_id 内容库 ID

where 可参考查询数据中的使用方式

开发者只需要获取对象总数，则可以通过设置 limit=1 以及 return_total_count=1 来达到该效果，total_count 可从返回的 meta 中获取

请求示例：

  1. https://{{服务器域名}}/hserve/v2.2/content/detail/?limit=1&return_total_count=1

请求示例

  1. curl -X GET \
  2. -H "X-Hydrogen-Client-ID: [[client_id]]" \
  3. -H "Authorization: Hydrogen-r1 {{AccessToken}}" \
  4. -H "Content-Type: application/json" \
  5. https://{{服务器域名}}/hserve/v2.2/content/detail/?content_group_id=1548659930013242

返回参数说明

参数类型说明
idinteger内容 ID
titlestring内容标题
coverfile封面图
descriptionstring内容摘要
categoriesarray所需分类的 ID
group_idinteger内容库 ID
created_atinteger内容创建时间
updated_atinteger内容更新时间
created_byinteger创建者 id
offsetinteger偏移量
limitinteger每次请求返回的最大记录数目
previousstring上一页地址
nextstring下一页地址
total_countinteger记录总数目，仅当 return_total_count 为 1 时返回

返回示例

  1. {
  2.     "meta": {
  3.         "next": null,
  4.         "total_count": 1,
  5.         "previous": null,
  6.         "offset": 0,
  7.         "limit": 20
  8.     },
  9.     "objects": [
  10.         {
  11.             "id": 1548659954888866,
  12.             "cover": "https://cloud-minapp-18630.cloud.ifanrusercontent.com/1go1CEZfzPGKLfdP.jpg",
  13.             "description": "",
  14.             "categories": [
  15.                 1554806170889376,
  16.                 1554806175759642
  17.             ],
  18.             "created_by": 16042162,
  19.             "updated_at": 1554806203,
  20.             "title": "hello",
  21.             "group_id": 1548659930013242,
  22.             "created_at": 1548659954
  23.         }
  24.     ]
  25. }

获取内容详情

接口

GET /hserve/v2.2/content/detail/:content_id/

其中 content_id 是内容的 ID

请求示例

  1. curl -X GET \
  2. -H "X-Hydrogen-Client-ID: [[client_id]]" \
  3. -H "Authorization: Hydrogen-r1 {{AccessToken}}" \
  4. -H "Content-Type: application/json" \
  5. https://{{服务器域名}}/hserve/v2.2/content/detail/1/

返回示例

  1. {
  2.     "id": 1548659954888866,
  3.     "cover": "https://cloud-minapp-18630.cloud.ifanrusercontent.com/1go1CEZfzPGKLfdP.jpg",
  4.     "description": "",
  5.     "created_at": 1548659954,
  6.     "created_by": 16042162,
  7.     "content": "<p><img src=\"https://cloud-minapp-18630.cloud.ifanrusercontent.com/1go1CJNRACOs442M.jpg\"/></p>",
  8.     "updated_at": 1554806203,
  9.     "title": "hello",
  10.     "group_id": 1548659930013242,
  11.     "categories": [
  12.         1554806170889376,
  13.         1554806175759642
  14.     ]
  15. }

返回参数说明

内容表内置字段：

参数类型说明
idinteger内容 ID
titlestring内容标题
contentstring详细容
coverfile封面图
descriptionstring内容摘要
group_idinteger内容库 ID
categoriesinteger array内容所属分类的ID
created_atinteger内容创建时间
updated_atinteger内容更新时间

状态码说明

200: 获取成功