一.基本约定
1.开发机、测试机代理地址:
mrobot开发机代理:192.168.10.199 端口:1080
mrobot测试机代理:192.168.10.198 端口:1080
2.当接口处理正常时,HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。
3.当接口处理异常时,HTTP STATUS CODE 返回非200,并且给出具体的错误信息。
{
"desc":"给用户的提示放在这里"
}
4.接口默认的字符编码是UTF-8,接口需要实现对req-enc和resp-enc参数的支持。
5.所有有写操作的数据接口,必须用POST方式提交,在接口里需要判断提交方式,拒绝GET的调用请求。
6.接口中的JSON字符串,key都用双引号("")包裹,value是字符串类型时,也用双引号("")包裹;是数字类型时,不用引号
7.需要分页的接口,统一返回以下字段: pageNo,pageSize,total
8.涉及接口都增加请求参数:v = 220 //版本号(数字)
9.发帖,回帖中status字段值的含义如下:
STATUS_ERROR = -1; //错误
STATUS_SUCCESS = 0; //成功
STATUS_NO_RIGHT = 1; //没有权限
STATUS_PARAM_WRONG = 2; //参数错误
STATUS_CONTENT_OVERFLOW = 3; //内容超出长度
STATUS_EXISTS = 4; //数据已经存在
STATUS_NOT_FOUND = 5; //数据查找不到
STATUS_NO_LOGIN = 6; //没有登录
STATUS_USER_LOCK = 7; //用户被锁
当status不等于0时,具体原因参照message字段的说明。
二.接口列表
1.0 广告
备注:获取广告数据(接口已完成,使用请连开发机代理)
mrobot接口URL:http://mrobot.pcbaby.com.cn/v3/ad
后端接口URL:http://ivy.pconline.com.cn/adpuba/show?id=pc.khd.zx.btxfldxj.&media=js
HTTP请求方式:GET
是否需要登录:否
返回格式:JSON
缓存方式:无
缓存时间:无
请求参数:
||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||=说明=||
||pageNo||页数||int||1||是||= 为1时返回主页的内容 =||
||pageSize||页面大小||int||10||是||= =||
||= deviceID =||=设备ID =||= string =||= "" =||= 是 =||= 应用端需要 =||
||city||城市||String||""||否||= mrobot请求主页数据时用到 =||
||project||感兴趣的项目||String||""||否||= mrobot请求主页数据时用到 =||
返回结果:
{
}
返回结果说明:
||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
||= contentID =||= 内容ID=||= title =||=标题=||
||= nickName =||= 用户昵称=||= userID =||=用户ID,用于查看ta的主页=||
||= type =||= 1:日记,2:帖子=||= imageUrl =||=推荐图=||
||= commentCount =||= 评论数=||= laudCount =||=点赞数=||
||= index =||= 当pageno=1时,返回首页接口数据=||=hasLaud=||=是否点赞,1:已点赞,0:未点赞=||
||= isExample =||当type==2时,要判断是否为旧案例数据,isExample==1时为旧案例数据,默认为0||==||==||