Changes between Initial Version and Version 1 of pcauto_bbs_1.0.0/intfs


Ignore:
Timestamp:
03/25/2013 09:30:27 AM (13 years ago)
Author:
leijingtang
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • pcauto_bbs_1.0.0/intfs

    v1 v1  
     1=== 1.基本约定 === 
     2{{{ 
     31.当接口处理正常时,HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。 
     4 
     52.当接口处理异常时,HTTP STATUS CODE 返回给500,并且给出具体的错误信息。 
     6    { 
     7        "uri" : "/intf/albums-by-type.jsp", 
     8        "error-desc":"Need you follow uid.", 
     9        "user-notice":"给用户的提示放在这里" 
     10    } 
     11 
     12     
     133.接口默认的字符编码是UTF-8,接口需要实现对req-enc和resp-enc参数的支持。在JSP的最顶部,实现类似下面的代码: 
     14 
     15        String queryString = request.getQueryString(); 
     16        String requestEncoding = getParam(queryString,"req_enc"); 
     17        String responseEncoding = getParam(queryString,"resp_enc"); 
     18        if(isNotBlank(requestEncoding)){ 
     19            request.setCharacterEncoding(requestEncoding); 
     20        } 
     21        if(isNotBlank(responseEncoding)){ 
     22            response.setCharacterEncoding(responseEncoding); 
     23        } 
     24 
     254.所有有写操作的数据接口,必须用POST方式提交,在接口里需要判断提交方式,拒绝GET的调用请求。 
     26 
     275.接口中的JSON字符串,key都用双引号("")包裹,value是字符串类型时,也用双引号("")包裹;是数字类型时,不用引号。 
     28 
     29}}} 
     30 
     31== 2.接口列表 == 
     32=== 2.1 /newMsgCount === 
     33{{{ 
     34    HTTP请求方式:get                          
     35    是否需要登录:否                           
     36    请求参数:none 
     37    返回参数: 
     38    { "newMsgCount": 2000 } 
     39    newMsgCount:新消息的数量,当该数值超过五位数时,只返回99999。 
     40 
     41}}} 
     42 
     43=== 2.2 /我的帖子=== 
     44{{{ 
     45url: http://mrobot.pcautobbs.com.cn/v4/individualcenter/post?personname=%@&common_session_id=%d?&pageno=%d&pagesize=%d 
     46例子:  
     47注:电脑网,汽车网用一样的接口,只需要改前缀:pcauto,pconline 
     48请求方式:get 
     49是否需要登录:是 
     50请求参数: 
     51pageNo:页数   persionName:用户名 common_session_id:用户登陆后获得的认证id  pageSize:每页条数  
     52 
     53时间规则:小于15分钟文案为:“××分钟前”;大于等于15分钟小于等于30分钟文案为:“半小时前”;大于30分钟小于等于60分钟文案为:“1小时前”;大于60分钟小于等于24小时文案为“××小时前”;大于24小时小于等于48小时文案为:“昨天”;大于48小时小于等于72小时文案为:“前天”;大于72小时则统一格式:“年-月-日” 
     54例子: 
     55 
     56    "pageNo":1, //页码 
     57    "pageSize":20, //每页条数 
     58    "topicList":[  / 
     59        {/每条的数据 
     60            "createTime":123,   //创建时间,见时间规则 
     61            "flag":"精", //是否为精,图等 
     62            "replyCount":6175,//回复数 
     63            "view":195872,//阅读数 
     64             "floor":812,//楼层数 
     65            "title":"三两下root好并精简你的三星I9100",//标题 
     66            "topicId":13597147, // 帖子id 
     67            "uri":"http://itbbs.pconline.com.cn/mobile/13597147.html" //帖子url   
     68         } 
     69    ], 
     70    "total":12  //一共多少条 
     71} 
     72}}} 
     73 
     74=== 2.3 /我的回复=== 
     75{{{ 
     76url: http://mrobot.pcautobbs.com.cn/v4/individualcenter/reply? personname=%@&common_session_id=%d?&pageno=%d&pagesize=%d 
     77例子:  
     78请求方式:get  
     79是否需要登录:是 
     80请求参数: 
     81时间规则:小于15分钟文案为:“××分钟前”;大于等于15分钟小于等于30分钟文案为:“半小时前”;大于30分钟小于等于60分钟文案为:“1小时前”;大于60分钟小于等于24小时文案为“××小时前”;大于24小时小于等于48小时文案为:“昨天”;大于48小时小于等于72小时文案为:“前天”;大于72小时则统一格式:“年-月-日” 
     82 
     83pageNo:页数   persionName:用户名 common_session_id:用户登陆后获得的认证id  pageSize:每页条数  
     84例子: 
     85 
     86    "pageNo":1, //页码 
     87    "pageSize":20, //每页条数 
     88    "topicList":[  / 
     89        {/每条的数据 
     90            "createTime":123,   //创建时间,见时间规则 
     91            "floorIndex":812,//评论所属的楼层 
     92            "title":"三两下root好并精简你的三星I9100",//标题 
     93             "replyContent":"回复内容为9",  //回复内容 
     94            "topicId":13597147, // 帖子id 
     95            "uri":"http://itbbs.pconline.com.cn/mobile/13597147.html" //帖子url   
     96         } 
     97    ], 
     98    "total":12  //一共多少条 
     99} 
     100}}} 
     101 
     102=== 2.4 /最新消息=== 
     103{{{ 
     104url: http://mrobot.pcautobbs.com.cn/v4/individualcenter/news? personname=%@&common_session_id=%d?&pageno=%d&pagesize=%d 
     105例子:  
     106请求方式:get  
     107是否需要登录:是 
     108请求参数:  
     109pageNo:页数   persionName:用户名 common_session_id:用户登陆后获得的认证id  pageSize:每页条数  
     110 
     111时间规则:小于15分钟文案为:“××分钟前”;大于等于15分钟小于等于30分钟文案为:“半小时前”;大于30分钟小于等于60分钟文案为:“1小时前”;大于60分钟小于等于24小时文案为“××小时前”;大于24小时小于等于48小时文案为:“昨天”;大于48小时小于等于72小时文案为:“前天”;大于72小时则统一格式:“年-月-日” 
     112 
     113 
     114    "pageNo":1, //页码 
     115    "pageSize":20, //每页条数 
     116    "topicList":[  / 
     117        {/每条的数据 
     118            "createTime":123,   //创建时间,见时间规则 
     119            “tag”:”postReplay”   //包括''system”,”stationMail”,”postReplay” 三种类型 
     120            "content":"三两下root好并精简你的三星I9100",   //内容,三者都有 
     121            "uri":"http://itbbs.pconline.com.cn/mobile/13597147.html" //url   
     122            “username”:”haha”           //postReplay,stationMail 中的用户名 
     123            “useId”: 12314212          //postReplay,stationMail 中的用户id 
     124            “postTitle”: “给力三星I9100”         //postReplay中的帖子标题 
     125            “floorIndex”: 3        //postReplay中的回帖的楼层数 
     126            "topicId":13597147, // postReplay帖子id 
     127         } 
     128    ], 
     129    "total":12  //一共多少条 
     130} 
     131}}} 
     132 
     133=== 2.5 /头像修改=== 
     134{{{ 
     135url : http://mrobot.pcautobbs.com.cn/v4/proxy/saveavatar" 
     136请求方式:post  
     137是否需要登录:需要 
     138请求参数: 
     139name:用户名  
     140image:用户头像数据 
     141common_session_id:会话id 
     142}}} 
     143 
     144=== 2.6 /帖子回复=== 
     145{{{ 
     146url: http://mrobot.pcauto.com.cn/v4/individualcenter/postreply? personname=%@&common_session_id=%d?&pageno=%d&pagesize=%d 
     147电脑网:命名前缀pconline 
     148例子:  
     149请求方式:get  
     150是否需要登录:是 
     151请求参数: 
     152pageNo:页数 persionName:用户名 common_session_id:用户登陆后获得的认证id pageSize:每页条数  
     153 
     154时间规则:小于15分钟文案为:“××分钟前”;大于等于15分钟小于等于30分钟文案为:“半小时前”;大于30分钟小于等于60分钟文案为:“1小时前”;大于60分钟小于等于24小时文案为“××小时前”;大于24小时小于等于48小时文案为:“昨天”;大于48小时小于等于72小时文案为:“前天”;大于72小时则统一格式:“年-月-日” 
     155 
     156例子: 
     157 
     158 
     159      "pageNo":1, //页码 
     160      "pageSize":20, //每页条数 
     161     "topicList":[ / 
     162          {/每条的数据 
     163          "pageNo":1, //页码 
     164          "pageSize":20, //每页条数 
     165          "topicList":[ / 
     166               {/每条的数据 
     167               "createTime":123, //创建时间,见时间规则 
     168               "replyName":“你好” //回复者名称, 
     169               "replyImage":“http://mrobot….jpg” //回复者头像url 
     170               "title":"三两下root好并精简你的三星I9100",//标题 
     171               "replyContent":"回复内容为9", //回复内容 
     172               "topicId":13597147, // 帖子id 
     173               "uri":"http://itbbs.pconline.com.cn/mobile/13597147.html" //帖子url       
     174               }      
     175          } 
     176     ], 
     177     "total":12 //一共多少条 
     178} 
     179}}} 
     180 
     181=== 2.7 /评论回复=== 
     182{{{ 
     183url: http://mrobot.pcauto.com.cn/v4/individualcenter/commentreply? personname=%@&common_session_id=%d?&pageno=%d&pagesize=%d 
     184电脑网:命名前缀pconline 
     185例子:  
     186请求方式:get  
     187是否需要登录:是 
     188请求参数:  
     189pageNo:页数 persionName:用户名 common_session_id:用户登陆后获得的认证id pageSize:每页条数  
     190 
     191时间规则:小于15分钟文案为:“××分钟前”;大于等于15分钟小于等于30分钟文案为:“半小时前”;大于30分钟小于等于60分钟文案为:“1小时前”;大于60分钟小于等于24小时文案为“××小时前”;大于24小时小于等于48小时文案为:“昨天”;大于48小时小于等于72小时文案为:“前天”;大于72小时则统一格式:“年-月-日” 
     192 
     193 
     194      "pageNo":1, //页码 
     195      "pageSize":20, //每页条数 
     196     "topicList":[ / 
     197          {/每条的数据 
     198          "pageNo":1, //页码 
     199          "pageSize":20, //每页条数 
     200          "topicList":[ / 
     201               {/每条的数据 
     202               "createTime":123, //创建时间,见时间规则 
     203               "replyName":“你好” //回复者名称, 
     204               "replyImage":“http://mrobot….jpg” //回复者头像url 
     205               "title":"三两下root好并精简你的三星I9100",//标题 
     206               "replyContent":"回复内容为9", //回复内容 
     207               "topicId":13597147, // 帖子id 
     208               "uri":"http://itbbs.pconline.com.cn/mobile/13597147.html" //帖子url       
     209               }      
     210          } 
     211     ], 
     212     "total":12 //一共多少条 
     213} 
     214}}}