Changes between Version 1 and Version 2 of pcauto_4.1.0/interface


Ignore:
Timestamp:
12/16/2013 09:46:45 AM (12 years ago)
Author:
leijingtang
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • pcauto_4.1.0/interface

    v1 v2  
    1 todo 
     1[[TOC]] 
     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注意：需要用getQueryString()，不能用getParameter() 
     17String queryString = request.getQueryString(); 
     18String reqEnc = getQueryValue(queryString,"req_enc="); 
     19if(reqEnc!=null){ 
     20    request.setCharacterEncoding(reqEnc); 
     21} 
     22String respEnc = getQueryValue(queryString,"resp_enc="); 
     23if(respEnc!=null){ 
     24    //out.println(respEnc); 
     25    response.setCharacterEncoding(respEnc); 
     26} 
     27String 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 
     444.所有有写操作的数据接口，必须用POST方式提交，在接口里需要判断提交方式，拒绝GET的调用请求。 
     45 
     465.接口中的JSON字符串，key都用双引号("")包裹，value是字符串类型时，也用双引号("")包裹；是数字类型时，不用引号。 
     47 
     486.需要登录的接口，cache-control=600 ；分开优先级低和主动请求两种，前者用cacheFirst，后者用noCache 
     49}}} 
     50 
     51 
     52== 2.接口列表 == 
     53 
     54 
     55=== 2.1 [=#point201 左侧主菜单]=== 
     56{{{ 
     57    url:madmin 配置项：http://mrobot.pcauto.com.cn/configs/pcauto_left_menu 
     58    作用:左侧主菜单 
     59    使用范围:汽车网app 
     60 
     61    HTTP请求方式：get                          
     62    是否需要登录：否                           
     63    请求参数：none 
     64    设计稿：http://192.168.50.175/work/201309/pcauto4.0/shouye/page.html 
     65    返回参数： 
     66 
     67[ 
     68    { 
     69        "id":1, 
     70        "img":"http://img0.pcauto.com.cn/pcauto/1310/16/3233041_Img388290093_thumb.jpg", 
     71        "title":"首页", 
     72        "view":"information-home/", 
     73        "url":"http://www.baidu.com" 
     74    }, 
     75    { 
     76        "id":2, 
     77        "img":"http://img0.pcauto.com.cn/pcauto/1310/16/3233041_Img388290093_thumb.jpg", 
     78        "title":"降价", 
     79        "view":"more/", 
     80        "url":"http://www.baidu.com" 
     81    }, 
     82    { 
     83        "id":3, 
     84        "img":"http://img0.pcauto.com.cn/pcauto/1310/16/3233041_Img388290093_thumb.jpg", 
     85        "title":"找车", 
     86        "view":"brand-list/", 
     87        "url":"" 
     88    }, 
     89    { 
     90        "id":4, 
     91        "img":"http://img0.pcauto.com.cn/pcauto/1310/16/3233041_Img388290093_thumb.jpg", 
     92        "title":"论坛", 
     93        "view":"bbs-home/", 
     94        "url":"" 
     95    }, 
     96    { 
     97        "id":5, 
     98        "img":"http://img0.pcauto.com.cn/pcauto/1310/16/3233041_Img388290093_thumb.jpg", 
     99        "title":"行情", 
     100        "view":"more/", 
     101        "url":"http://www.baidu.com" 
     102    }, 
     103    { 
     104        "id":6, 
     105        "img":"http://img0.pcauto.com.cn/pcauto/1310/16/3233041_Img388290093_thumb.jpg", 
     106        "title":"图集", 
     107        "view":"album-list/", 
     108        "url":"" 
     109    } 
     110] 
     111 
     112}}} 
     113 
     114 
     115== 3.开发时间、负责人、进度和实现方式== 
     116 
     117||批次||= 页面 =||= 涉及MROBOT接口 =||=是否需要[[BR]]HTML切图 =||= 需配合的接口负责人[[BR]]及进度 =||= 接口开发[[BR]]预计时间 =||=接口进度（百分比）=||=接口实际[[BR]]完成时间=||=实现方式=|| 
     118||第一批|| 首页 ||2.1 [#point201 左侧主菜单 ] ||- || - ||  - || 已上线 || - || madmin配置 
     119||第一批|| 首页 ||2.2 [#point202 默认订阅栏目 ] ||- || - || - || 已上线  || - || madmin配置 
     120||第一批|| 首页 ||2.3 [#point203 头条 ] ||- || - || - || 已上线 || - || mrobot实现 
     121||第一批|| 车系聚合页 ||2.3.1 [#point203 车系聚合页 ] ||- || - || - || 已上线 || - || mrobot实现 
     122||第一批|| 文章、帖子、图集 ||2.4 [#point204 赞和踩 ] ||- || -  || - || 已上线 || -  || mrobot-data实现 
     123||第一批|| 资讯栏目 ||2.5 [#point205 搜索栏目文章 ] ||- || - || - || 已上线 || - || mrobot实现   
     124||第一批|| 个人中心 ||2.6 [#point206 新消息 ] ||- || 个人中心同事  ||-|| 已上线 || - || mrobot代理   
     125||第一批|| 左侧菜单 ||2.7 [#point207 您可能对以下内容感兴趣 ] ||- || - ||-|| 已上线 || - || madmin配置 
     126||第一批|| 我的收藏 ||2.8 [#point208 收藏夹信息---文章 ] ||-|| 个人中心同事  ||-|| 已上线 || - || mrobot代理   
     127||第一批|| 我的收藏 ||2.9 [#point209 收藏夹信息---帖子 ] ||- || 个人中心同事 ||-|| 已上线 || - || mrobot代理 
     128||第一批|| 我的收藏 ||2.10 [#point210 收藏夹信息---车型 ] ||- || 个人中心同事  ||-|| 已上线 ||-|| mrobot代理   
     129||第一批|| 我的收藏 ||2.11 [#point211 添加收藏 ] ||- || 个人中心同事  ||-|| 已上线 ||-|| 外部系统实现 
     130||第一批|| 我的收藏 ||2.12[#point212 删除收藏 ]  || - || 个人中心同事 ||-|| 已上线 || - || 外部系统实现 
     131||第一批|| 我的订阅 ||2.13 [#point213 获取我的订阅 ] ||- || 个人中心同事 ||-|| 已上线 ||-|| mrobot代理   
     132||第一批|| 我的订阅 ||2.14 [#point214 添加我的订阅 ] ||- || 个人中心同事 ||-|| 已上线  || - || 外部系统实现  
     133||第一批|| 我的订阅 ||2.15 [#point215 删除我的订阅 ] ||- || 个人中心同事 ||-|| 已上线  || - || 外部系统实现   
     134||第一批|| 我的消息 ||2.16 [#point216 获取提醒内容 ] ||- || 个人中心同事  ||-|| 已上线 || -  || mrobot代理   
     135||第一批|| 我的消息 ||2.17 [#point217 删除提醒 ]||- || 个人中心同事  ||-|| 已上线 || - || 外部系统实现 
     136||第一批|| 我的消息 ||2.18 [#point218 获取私信列表 ] ||- || 个人中心同事 ||-|| 暂时不做 || - || mrobot代理   
     137||第一批|| 我的消息 ||2.19 [#point219 获取个人私信 ] ||- || 个人中心同事 ||-|| 暂时不做 || - || mrobot代理   
     138||第一批|| 我的消息 ||2.20 [#point220 发送私信 ] ||-|| 个人中心同事  ||-|| 已上线 ||- || 外部系统实现 
     139||第一批|| 我的消息 ||2.21 [#point221 删除私信 ] ||-|| 个人中心同事  ||-|| 已上线 ||- || 外部系统实现 
     140||第一批|| 我的帖子 ||2.22 [#point222 获取我的帖子 ] ||-|| 个人中心同事  ||-|| 已上线 ||- || mrobot代理 
     141||第一批|| 车型库首页品牌列表 ||2.23 [#point223 车型库首页品牌列表 ] ||-|| -  ||-|| 已上线 ||- || mrobot代理 
     142||第一批|| 精准选车条件 ||2.24 [#point224 精准选车条件 ] ||-|| -  ||-|| 已上线 ||- || mrobot实现 
     143||第一批|| 车主点评列表 ||2.25 [#point225 获取车主点评列表 ] ||-|| 车型库同事  ||-|| 已上线 ||- || mrobot实现 
     144||第一批|| 图片终端页 ||2.26 [#point226 车型图片列表 ] ||-|| 车型库同事  ||-|| 已上线 ||- || mrobot代理 
     145||第一批|| 论坛帖子列表 ||2.27 [#point227 论坛帖子列表 ] ||-|| 论坛同事  ||-|| 已上线 ||- || mrobot代理 
     146||第一批|| 询底价页 ||2.28 [#point228 询底价页 ] ||-|| 前端同事  ||-|| 已上线 ||- || mrobot实现 
     147||第一批|| 经销商详情页 ||2.29 [#point229 经销商详情页 ] ||-|| 车型库、前端同事  ||-|| 已上线 ||- || mrobot实现 
     148||第一批|| 车型终端页 ||2.30 [#point230 车型终端页 ] ||-|| 车型库、前端同事  ||-|| 已上线 ||- || mrobot实现 
     149||第一批|| 车型对比页 ||2.31 [#point231 车型对比页 ] ||-|| 车型库、前端同事  ||-|| 已上线 ||- || mrobot实现 
     150||第一批|| 车主点评终端页 ||2.32 [#point232 车主点评终端页 ] ||-|| 车型库、前端同事  ||-|| 已上线 ||- || mrobot实现 
     151||第一批|| 预约驾车页 ||2.33 [#point233 预约驾车页 ] ||-|| 车型库、前端同事  ||-|| 已上线 ||- || mrobot实现 
     152||第一批|| 车型降价信息 ||2.34 [#point234 车型降价信息 ] ||-|| 车型库同事  ||-|| 已上线 ||- || mrobot代理 
     153||第一批|| 文章和帖子终端页 ||2.35 [#point235 文章终端页和帖子终端页 ] ||-|| -  ||-|| 已上线 ||- || mrobot实现 
     154||第一批|| 车型库图集类别 ||2.36 [#point236 车型库图集类别 ] ||-|| -  ||-|| 已上线 ||- || mamdin实现 
     155||第一批|| 车型库图集类别 ||2.37 [#point237 编辑订阅列表 ] ||-|| 个人中心同事 ||-|| 暂时不做 ||- || 外部系统实现 
     156||第一批|| 车型库图集类别 ||2.38 [#point238 车型库首页热门车系列表 ] ||-|| - ||-|| 已上线 ||- || madmin实现 
     157||第一批|| 车系页 ||2.39 [#point239 车系页 ] ||-|| - ||-|| 已上线 ||- || mrobot代理 
     158||第一批|| 栏目页 ||2.40 [#point240 新增栏目 ] ||-|| - ||-|| 已上线 ||- || mamdin实现 
     159||第一批|| 论坛 ||2.41 [#point241 热门帖子 ] ||-|| - ||-|| 已上线 ||- || mrobot代理 
     160||第一批|| 论坛 ||2.42 [#point242 汽车网车系列表 ] ||-|| - ||-|| 已上线 ||- || mrobot代理 
     161||第一批|| 论坛 ||2.43 [#point243 判断版块、帖子是否已经收藏 ] ||-|| - ||-|| 已上线 ||- || 外部系统实现