Changes between Version 2 and Version 3 of pcauto_pconline_4.0.0/intf


Ignore:
Timestamp:
03/26/2013 02:59:54 PM (13 years ago)
Author:
yaoming
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • pcauto_pconline_4.0.0/intf

    v2 v3  
    11[[http://trac.pc.com.cn/iphone/wiki/pcauto_pconline_4.0.0/intf/leijingtang | 接口1]] 
     2 
     3=== 1.基本约定 === 
     4{{{ 
     51.当接口处理正常时，HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。 
     6 
     72.当接口处理异常时，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     
     153.接口默认的字符编码是UTF-8，接口需要实现对req-enc和resp-enc参数的支持。在JSP的最顶部，实现类似下面的代码： 
     16 
     17        String queryString = request.getQueryString(); 
     18        String requestEncoding = getParam(queryString,"req_enc"); 
     19        String responseEncoding = getParam(queryString,"resp_enc"); 
     20        if(isNotBlank(requestEncoding)){ 
     21            request.setCharacterEncoding(requestEncoding); 
     22        } 
     23        if(isNotBlank(responseEncoding)){ 
     24            response.setCharacterEncoding(responseEncoding); 
     25        } 
     26 
     274.所有有写操作的数据接口，必须用POST方式提交，在接口里需要判断提交方式，拒绝GET的调用请求。 
     28 
     295.接口中的JSON字符串，key都用双引号("")包裹，value是字符串类型时，也用双引号("")包裹；是数字类型时，不用引号。 
     30 
     31}}} 
     32 
     33== 2.接口列表 == 
     34=== 2.1 /newMsgCount === 
     35{{{ 
     36    HTTP请求方式：get                          
     37    是否需要登录：否                           
     38    请求参数：none 
     39    返回参数： 
     40    { "newMsgCount": 2000 } 
     41    newMsgCount:新消息的数量，当该数值超过五位数时，只返回99999。新消息是指汽车论坛的站内信，不包括认证失败的消息。 
     42 
     43}}} 
     44 
     45=== 2.2 http://mrobot.pconline.com.cn/v2/cms/channels/1  &&  http://mrobot.pcauto.com.cn/v2/cms/channels/1=== 
     46{{{ 
     47    HTTP请求方式：get 
     48    是否需要登录：否 
     49    请求参数 
     50    { 
     51    "topArticle":[ 
     52 
     53        { 
     54            "pubDate":"2013-03-20", 
     55            "title":"专利败诉 HTC再度悲剧……", 
     56            "updateAt":1363708800000, 
     57            "to-uri":"pconlinebrowser://bbs-topic/16348932", 
     58            "preView":"专利败诉 HTC再度悲剧……", 
     59            "seq":15, 
     60            "image":"http://img0.pconline.com.cn/pconline/1303/20/3220919_f3.jpg", 
     61            "floorCount":15    // 楼层数 
     62        }, 
     63        { 
     64            "pubDate":"2013-03-11", 
     65            "title":"摄影部落美图——《日出赛罕坝》", 
     66            "updateAt":1362931200000, 
     67            "to-uri":"pconlinebrowser://album-photo/9792", 
     68            "preView":"摄影部落美图——《日出赛罕坝》", 
     69            "seq":20, 
     70            "image":"http://img0.pconline.com.cn/pconline/1303/11/3209641_f2.jpg", 
     71            "numCount":20    //  图集的图片张数 
     72        } 
     73    ], 
     74    "articleList":[ 
     75         
     76    ], 
     77    "topFocus":[ 
     78    ] 
     79} 
     80    备注：除topArticle外的数据，其他都不变，topArticle里面的论坛和图集分别增加一个楼层数和图集张数的字段 
     81}}}