程序接口说明书是进行接口调用的依据,编写本文档的目的在于为调用的接口提供详细的说明,使前端程序员能根据详细的接口说明进行正确的调用,并且以需求说明为依据。

案例列表分页接口

接口说明

通过分页的方式加载案例的列表页所需要的数据

接口地址

GET|POST http://wps.h5gf.cn/index/thing/getThing

接口请求参数

字段名字段必填说明数据类型
页数page请求的页数(为 0 时,返回 top 条数据)Int
每页条数listRows每页的条数Int
首次加载条数top当 Page 为 0 时,加载的条数Int
行业trade所选行业 IDInt
场景scene所选场景 IDInt
节庆festival所选节庆 IDInt
搜索title所要搜索的内容String

接口返回参数

字段名字段说明
返回状态码code0 为成功;
返回信息msg返回信息,提示信息
返回数据data具体说明如下

Data

字段名字段说明数据类型
IDid当前案例的 IDInt
标题title当前案例的标题String
跳转地址url弃用String
首页(横)index弃用Int
首页(竖)assisted弃用Int
图片photo所展示的图片Array
优先级sort数值越大,排序越高Int
行业trade行业 IDInt
场景scene场景 IDInt
节庆festival节庆 IDInt
类型sorts类型 IDInt
标签tag案例所有的标签Array
案例介绍introduce案例介绍String
创意亮点special创意亮点String
二维码code二维码图片地址String

接口返回参数示例

{
"code": 0,
"msg": "OK",
-"data": [
  -{
    "id": 39,
    "title": "良品铺子:春节过招 家乡话挑战赛",
    "url": "",
    "index": 0,
    "assisted": 0,
    -"photo": [
      "http://wps.h5gf.cn/images/20180119/521dbe803eca4e0d38883fca54c4b0df.jpg",
      "http://wps.h5gf.cn/images/20180119/fa671ae14600d0716ee395511b03864e.jpg",
      "http://wps.h5gf.cn/images/20180119/7b285150a2214eda13e7af9897f6d5ec.jpg"
    ],
    "sort": 6,
    "trade": 3,
    "scene": 1,
    "festival": 7,
    "sorts": 2,
    -"tag": [
      "手绘",
      "答题测试",
      "语音识别"
    ],
    "introduce": "策划上,测试答题类,春节过招,家乡话挑战赛,点击首页“开始挑战”后,选择挑战区,开启方言测试,共有五道测试题;",
    "special": "设计上,漫画风格,采用黄色作为主色调,蓝色作为辅色调,里面的主人公的形象搞笑",
    "code": "http://wps.h5gf.cn/images/20180119/1ad095920c7d2a4f53f18b5a9ea09920.png"
  },
  -{
    "id": 46,
    "title": "搜狐新闻:单身汪 VS 情侣喵大作战",
    "url": "",
    "index": 0,
    "assisted": 0,
    -"photo": [
      "http://wps.h5gf.cn/images/20180122/47622237ce77a278be276a56a41f78fd.jpg",
      "http://wps.h5gf.cn/images/20180122/e8bab1640b4e1960e08982c020c23237.jpg",
      "http://wps.h5gf.cn/images/20180122/0d0cd7687478af0f7f694e2eb75aab71.png"
    ],
    "sort": 5,
    "trade": 10,
    "scene": 2,
    "festival": 0,
    "sorts": 2,
    -"tag": [
      "小游戏"
    ],
    "introduce": "游戏类,先选择角色,单身汪 or 情侣喵,然后在 10 秒内,点击屏幕内随机出现的情侣喵们,两两消除",
    "special": "设计上,天蓝色配粉红色,一冷一暖,正切合单身汪和情侣喵的心情",
    "code": "http://wps.h5gf.cn/images/20180119/ce39f9b9676b50e5d982d08c142e89d1.png"
  },
  ]
}

更新文章访问量接口

访问量接口说明

访问些接口后会为对应 ID 的文章添加一个访问量

访问量接口地址

GET|POST http://wps.h5gf.cn/index/school/setRead

访问量接口请求参数

字段名字段必填说明数据类型
文章 IDid当前文章的 IDInt

访问量接口返回参数

字段名字段说明
返回状态码code0 为成功;
返回信息msg返回信息,提示信息
返回数据data具体说明如下

访问量 Data

字段名字段说明数据类型
访问量read当前文章的访问量Int

访问量接口返回参数示例

{
  "code": 0,
  "msg": "OK",
  -"data": {
    "read": 5009
  }
}

标签: 接口, PHP

添加新评论