程序接口说明书

发表于 2017-08-16

字数统计 5001

被 1703 人阅读

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

案例列表分页接口

接口说明

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

接口地址

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

接口请求参数

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

接口返回参数

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

Data

字段名	字段	说明	数据类型
ID	id	当前案例的ID	Int
标题	title	当前案例的标题	String
跳转地址	url	弃用	String
首页（横）	index	弃用	Int
首页（竖）	assisted	弃用	Int
图片	photo	所展示的图片	Array
优先级	sort	数值越大，排序越高	Int
行业	trade	行业ID	Int
场景	scene	场景ID	Int
节庆	festival	节庆ID	Int
类型	sorts	类型ID	Int
标签	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

接口请求参数

字段名	字段	必填	说明	数据类型
文章ID	id	是	当前文章的ID	Int

接口返回参数

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

Data

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

接口返回参数示例

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

#HTTP #说明书 #接口 #规范 #返回值 #请求

全部评论(0)

您的留言