[[TOC]] == 1.基本约定 == {{{ 1.当接口处理正常时,HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。 2.当接口处理异常时,HTTP STATUS CODE 返回给500,并且给出具体的错误信息。 { "uri" : "/intf/albums-by-type.jsp", "error-desc":"Need you follow uid.", "user-notice":"给用户的提示放在这里" }` 3.接口默认的字符编码是UTF-8,接口需要实现对req-enc和resp-enc参数的支持。在JSP的最顶部,实现类似下面的代码: String queryString = request.getQueryString(); String requestEncoding = getParam(queryString,"req_enc"); String responseEncoding = getParam(queryString,"resp_enc"); if(isNotBlank(requestEncoding)){ request.setCharacterEncoding(requestEncoding); } if(isNotBlank(responseEncoding)){ response.setCharacterEncoding(responseEncoding); } 4.所有有写操作的数据接口,必须用POST方式提交,在接口里需要判断提交方式,拒绝GET的调用请求。 5.接口中的JSON字符串,key都用双引号("")包裹,value是字符串类型时,也用双引号("")包裹;是数字类型时,不用引号。 }}} == 2.接口列表 == === 1 晒单列表 === {{{ URL: 备注:无 请求参数: 无 请求方法:get 是否需要登录:否 返回参数: { topics: [ 文章数组 { id: 48074, 文章id image: "http://img0.pconline.com.cn/pconline/jrzcz/1311/28525424_1384151163247_0_1024x1024.jpg", 导读图 title: "晒屌丝破车升级20寸轮毂+土豪邻居新车", 标题 time: "2013-11-13" 发表时间 } ] } }}} === 2 晒单终端 === {{{ URL:http://best.pconline.com.cn/intf/iphone/topicDetail_second.jsp 备注:文章终端形式 请求参数: topicId 文章终端ID 请求方法:get 是否需要登录:否 返回参数:web页面的 额外说明: 附加信息用注释的方式放到html代码里面以/*@_HTML_META_START_开头, _HTML_META_END_@*/结尾,里面的内容有评论url,标题以及发送微博用的图片url,用json格式 }}} === 3 评论 踩顶接口 === {{{ 与1.3.1文章终端页保持一致 }}} === 4 我的收藏 === {{{ URL:http://best.pconline.com.cn/intf/iphone/getCollectsForApp.jsp 参数:common_session_id: 登录后session,Cookies中 index:1 优惠海淘, 2 国内优惠, 3 发现频道, 4 晒单, 5 经验 pageNo: pageSize: 请求方法:get 是否需要登录:否 返回参数: { "products": [ { "id": 123, “title”: "", "time": "", "price": "", "eb": "",(电商名称) "image": "http://xxx", "invalid": (1已失效,0未失效) --后期增加 "good":"20", //值的数量 "bad":"1", //不值的数量 "commentNum":"0", //评论数 } ], "pageNo": 1, "pageSize": 20, "total": 100 } }}}