| 5 | | 1.当接口处理正常时,HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。 |
| 6 | | |
| 7 | | 2.当接口处理异常时,HTTP STATUS CODE 返回给500,并且给出具体的错误信息。 |
| 8 | | { |
| 9 | | "uri" : "/intf/albums-by-type.jsp", |
| 10 | | "error-desc":"Need you follow uid.", |
| 11 | | "user-notice":"给用户的提示放在这里" |
| 12 | | } |
| 13 | | |
| 14 | | |
| 15 | | 3.接口默认的字符编码是UTF-8,接口需要实现对req_enc和resp_enc参数的支持。在JSP的最顶部,实现类似下面的代码: |
| 16 | | 注意:需要用getQueryString(),不能用getParameter() |
| 17 | | String queryString = request.getQueryString(); |
| 18 | | String reqEnc = getQueryValue(queryString,"req_enc="); |
| 19 | | if(reqEnc!=null){ |
| 20 | | request.setCharacterEncoding(reqEnc); |
| 21 | | } |
| 22 | | String respEnc = getQueryValue(queryString,"resp_enc="); |
| 23 | | if(respEnc!=null){ |
| 24 | | //out.println(respEnc); |
| 25 | | response.setCharacterEncoding(respEnc); |
| 26 | | } |
| 27 | | String getQueryValue(String queryString,String key){ |
| 28 | | if(queryString==null || queryString.length()==0)return null; |
| 29 | | int reqIdx = queryString.indexOf(key);//req_enc=utf-8&resp_enc=gbk |
| 30 | | if(reqIdx!=-1){ |
| 31 | | reqIdx = reqIdx+key.length(); |
| 32 | | int endIdx = reqIdx; |
| 33 | | for (; |
| 34 | | endIdx < queryString.length() && queryString.charAt(endIdx)!='&'; |
| 35 | | endIdx++) { |
| 36 | | } |
| 37 | | if(endIdx>reqIdx){ |
| 38 | | return queryString.substring(reqIdx,endIdx); |
| 39 | | } |
| 40 | | } |
| 41 | | return null; |
| 42 | | } |
| 43 | | |
| 44 | | 4.所有有写操作的数据接口,必须用POST方式提交,在接口里需要判断提交方式,拒绝GET的调用请求。 |
| 45 | | |
| 46 | | 5.接口中的JSON字符串,key都用双引号("")包裹,value是字符串类型时,也用双引号("")包裹;是数字类型时,不用引号。 |
| 47 | | |
| 48 | | 6.需要登录的接口,cache-control=600 ;分开优先级低和主动请求两种,前者用cacheFirst,后者用noCache |
| | 5 | 接口默认的字符编码是UTF-8,接口需要实现对req_enc和resp_enc参数的支持 |
| | 50 | |
| | 51 | === 2.2 [=#point202 获取用户信息]=== |
| | 52 | {{{ |
| | 53 | |
| | 54 | 接口URL:http://mrobot.pcauto.com.cn/v3/bbs/getUserInfo |
| | 55 | |
| | 56 | 接口是否完善:否 |
| | 57 | 1.增加是否为验证车主标识 |
| | 58 | 2.增加验证车型 |
| | 59 | |
| | 60 | }}} |
| | 61 | |
| | 62 | === 2.3 [=#point203 验证码和发私信]=== |
| | 63 | {{{ |
| | 64 | 验证码接口 |
| | 65 | 接口URL:http://captcha.pcauto.com.cn/captcha/v.jpg |
| | 66 | 无参数 |
| | 67 | 返回一张验证码图片 |
| | 68 | |
| | 69 | 发私信接口 |
| | 70 | 接口URL:http://bip.pcauto.com.cn/intf/message.jsp?act=create |
| | 71 | 必填参数: |
| | 72 | accountId:发送给某个用户 |
| | 73 | content:消息内容 |
| | 74 | captcha:验证码 |
| | 75 | |
| | 76 | /* |
| | 77 | * 发送限制 add by handy 2012.04.01 |
| | 78 | * 1.post 2.验证码 3.黑名单 |
| | 79 | * 4.邮箱绑定,该限制仅限於2012-01-01起注册的用户 edit by handy 2012.04.10 |
| | 80 | * 5.发送频率 50次/ID/24H |
| | 81 | * 6.白名单最多一次发送50个用户,非白名单则每次只能发一个 7.添加关键词库过滤 |
| | 82 | */ |
| | 83 | |
| | 84 | 结果返回 |
| | 85 | {code:0,message:"提示"} |
| | 86 | }}} |
| | 87 | |
| | 88 | === 2.4 [=#point204 我的论坛接口]=== |
| | 89 | {{{ |
| | 90 | 接口URL:http://mrobot.pcauto.com.cn/v3/bbs/myTopics/13128876?pageNo=1&pageSize=20&maxLength=20 |
| | 91 | 接口是否已经完善:否 |
| | 92 | 1.参数增加删选类型,主贴|回帖|精华 |
| | 93 | 2,返回数据增加主|回帖标识,阅读数,主贴标题 |
| | 94 | 3,如果是回帖则增加回复内容,主贴作者ID和呢称 |
| | 95 | }}} |
| | 96 | |
| | 97 | === 2.5 [=#point205 我的收藏夹论坛列表]=== |
| | 98 | {{{ |
| | 99 | 接口是否已经完善:否 |
| | 100 | }}} |
| | 101 | |
| | 102 | === 2.6 [=#point206 我的评论]=== |
| | 103 | {{{ |
| | 104 | 接口是否已经完善:否 |
| | 105 | }}} |
| | 106 | |
| | 107 | === 2.7 [=#point207 我的好友列表]=== |
| | 108 | {{{ |
| | 109 | 包括关注的好友和粉丝,用一个状态来标识 |
| | 110 | |
| | 111 | 接口是否已经完善:否 |
| | 112 | }}} |
| | 113 | |
| | 114 | === 2.8 [=#point208 收到的私信列表]=== |
| | 115 | {{{ |
| | 116 | 接口URL:http://mrobot.pcauto.com.cn/v3/bbs/getMessageList?pageSize=20&pageNo=1 |
| | 117 | 接口是否已经完善:否 |
| | 118 | }}} |
| | 119 | |
| | 120 | === 2.9 [=#point209 发出的私信列表]=== |
| | 121 | {{{ |
| | 122 | 接口URL: |
| | 123 | 接口是否已经完善:否 |
| | 124 | }}} |
| | 125 | |
| | 126 | === 2.10 [=#point210 获取系统消息接口]=== |
| | 127 | {{{ |
| | 128 | 接口URL: |
| | 129 | 接口是否已经完善:否 |
| | 130 | }}} |
| | 131 | |
| | 132 | === 2.11 [=#point211 收集推送token接口]=== |
| | 133 | {{{ |
| | 134 | token数据放在passport2,赖子粼负责 |
| | 135 | 接口URL: |
| | 136 | 接口是否已经完善:否 |
| | 137 | }}} |
| | 138 | |
| | 139 | === 2.12 [=#point212 获取他人信息接口]=== |
| | 140 | {{{ |
| | 141 | 接口URL: |
| | 142 | 接口是否已经完善:否 |
| | 143 | }}} |
| | 144 | |
| | 145 | |
| | 146 | === 2.13 [=#point213 获取他人最新动态接口]=== |
| | 147 | {{{ |
| | 148 | 返回html页面 |
| | 149 | 接口URL: |
| | 150 | 接口是否已经完善:否 |
| | 151 | }}} |
| | 152 | |
| | 153 | === 2.14 [=#point214 获取他人帖子列表]=== |
| | 154 | {{{ |
| | 155 | 接口URL: |
| | 156 | 接口是否已经完善:否 |
| | 157 | }}} |
| | 158 | |
| | 159 | === 2.15 [=#point215 获取他人评论列表]=== |
| | 160 | {{{ |
| | 161 | 接口URL: |
| | 162 | 接口是否已经完善:否 |
| | 163 | }}} |
| | 164 | |
| | 165 | === 2.16 [=#point216 获取他人爱车列表]=== |
| | 166 | {{{ |
| | 167 | 接口URL: |
| | 168 | 接口是否已经完善:否 |
| | 169 | }}} |
| | 170 | |
| | 171 | === 2.17 [=#point217 获取他人好友列表]=== |
| | 172 | {{{ |
| | 173 | 接口URL: |
| | 174 | 接口是否已经完善:否 |
| | 175 | }}} |
| | 176 | |
| | 177 | === 2.18 [=#point218 关注好友]=== |
| | 178 | {{{ |
| | 179 | 接口URL: |
| | 180 | 接口是否已经完善:否 |
| | 181 | }}} |
| | 182 | |
| | 183 | === 2.19 [=#point219 精准选车-车系列表接口]=== |
| | 184 | {{{ |
| | 185 | 接口URL: |
| | 186 | 接口是否已经完善:否 |
| | 187 | }}} |
| | 188 | |