BBS拓展接口项目

请求地址: http://ip:port/clientRequest

请求参数: JSON

{
  "method" : "方法入口唯一标识",
  "data"   : "参照请求示例"
}

返回格式: JSON

{
  "code"   : 0,
  "message": "SUCCESS",
  "data"   : "参照返回示例"
}

Q1. 按类别表示获取标签列表 (method : genCategory)

参数列表: type

// 请求示例: 获取全部标签列表
{
  "method"  : "genCategory",
  "data"    : {
    "type"  : "all"
  }
}

/**
 * type
 *
 *    all     全部标签列表
 *    concern 用户关注标签列表
 *    usual   常用标签列表
 *    other   其他标签列表
 */

Q2. 按标签获取展示帖子列表 (method : genSubjectByCategory)

参数列表: pageSize pageNum category categoryId

// 请求示例: 按标签名称获取指定页帖子列表
{
  "method" : "genSubjectByCategory",
  "data" : {
    "page-size"  : 10,
    "page-num"   : 3,
    "category"   : "测试标签",
    "category-id": null
  }
}

// 请求示例: 按标签ID获取指定页帖子列表
{
  "method" : "genSubjectByCategory",
  "data" : {
    "page-size"  : 10,
    "page-num"   : 3,
    "category"   : null,
    "category-id": 123
  }
}

Q3. 按ID获取帖子详情信息 (method : genSubjectDetail)

参数列表: subjectId

// 请求示例: 按ID获取帖子详情信息
{
  "method"  : "genSubjectDetail",
  "data"    : {
    "subject-id" : 123
  }
}

R1. 标签列表数据格式限定

{
  "method"  : "请求方法入口",
  "code"    : 0,
  "message" : "SUCCESS",
  "data"    : {
    "type"  : "all",
    "category-list" : [
      {
        "id"    : "标签ID",
        "name"  : "标签名称"
      },
      {}
    ]
  }
}

R2. 帖子列表数据格式限定

{
  "method"  : "请求方法入口",
  "code"    : 0,
  "message" : "SUCCESS",
  "data"    : {
    "page-size"     : 2,
    "page-num"      : 10,
    "category"      : "养生",
    "category-id"   : null,
    "subject-list"  : [
      {
        "id"            : 1,
        "title"         : "帖子标题",
        "creator"       : "作者",
        "keywords"      : "关键词,关键词,关键词",
        "category-list" : ["", "帖子标签列表"],
        "resource-list" : ["http://素材地址", "http://素材地址"],
        "created"       : "2018-01-01"
      },
      {}
    ]
  }
}

R3. 帖子详情数据格式限定

{
  "method" : "genSubjectDetail",
  "code" : 0,
  "message" : "SUCCESS",
  "data" : {
    "subject-id" : "请求帖子ID",
    "detail" : {
      "id" : "对应请求帖子ID",
      "title" : "帖子标题",
      "creator" : "帖子作者",
      "content" : "帖子内容",
      "keywords": "帖子关键字",
      "support-number" : "帖子支持数",
      "reply-number" : "帖子回复数",
      "click-count" : "帖子点击数",
      "resource-list" : ["http://素材地址", "http://素材地址"],
      "category-list" : ["", "帖子标签列表"],
      "created" : "2018-12-18",
      "updated" : "2018-12-18"
    }
  }
}

健康文章推荐接口协议