[[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的最顶部，实现类似下面的代码：
注意：需要用getQueryString()，不能用getParameter()
String queryString = request.getQueryString();
String reqEnc = getQueryValue(queryString,"req_enc=");
if(reqEnc!=null){
    request.setCharacterEncoding(reqEnc);
}
String respEnc = getQueryValue(queryString,"resp_enc=");
if(respEnc!=null){
    //out.println(respEnc);
    response.setCharacterEncoding(respEnc);
}
String getQueryValue(String queryString,String key){
    if(queryString==null || queryString.length()==0)return null;
    int reqIdx = queryString.indexOf(key);//req_enc=utf-8&resp_enc=gbk
    if(reqIdx!=-1){
        reqIdx = reqIdx+key.length();
        int endIdx = reqIdx;
        for (; 
        endIdx < queryString.length() && queryString.charAt(endIdx)!='&'; 
        endIdx++) {
        }
        if(endIdx>reqIdx){
            return queryString.substring(reqIdx,endIdx);
        }
    }
    return null;
}

4.所有有写操作的数据接口，必须用POST方式提交，在接口里需要判断提交方式，拒绝GET的调用请求。

5.接口中的JSON字符串，key都用双引号("")包裹，value是字符串类型时，也用双引号("")包裹；是数字类型时，不用引号。

6.需要登录的接口，cache-control=600 ；分开优先级低和主动请求两种，前者用cacheFirst，后者用noCache
}}}


== 2.接口列表 ==


=== 2.1 [=#point201 左侧主菜单]===
{{{
    url:madmin 配置项：http://mrobot.pcauto.com.cn/configs/pcauto_left_menu
    作用:左侧主菜单
    使用范围:汽车网app

    HTTP请求方式：get                         
    是否需要登录：否                          
    请求参数：none
    设计稿：http://192.168.50.175/work/201309/pcauto4.0/shouye/page.html
    返回参数：

[
    {
        "id":1,
        "img":"http://img0.pcauto.com.cn/pcauto/1310/16/3233041_Img388290093_thumb.jpg",
        "title":"首页",
        "view":"information-home/",
        "url":"http://www.baidu.com"
    },
    {
        "id":2,
        "img":"http://img0.pcauto.com.cn/pcauto/1310/16/3233041_Img388290093_thumb.jpg",
        "title":"降价",
        "view":"more/",
        "url":"http://www.baidu.com"
    },
    {
        "id":3,
        "img":"http://img0.pcauto.com.cn/pcauto/1310/16/3233041_Img388290093_thumb.jpg",
        "title":"找车",
        "view":"brand-list/",
        "url":""
    },
    {
        "id":4,
        "img":"http://img0.pcauto.com.cn/pcauto/1310/16/3233041_Img388290093_thumb.jpg",
        "title":"论坛",
        "view":"bbs-home/",
        "url":""
    },
    {
        "id":5,
        "img":"http://img0.pcauto.com.cn/pcauto/1310/16/3233041_Img388290093_thumb.jpg",
        "title":"行情",
        "view":"more/",
        "url":"http://www.baidu.com"
    },
    {
        "id":6,
        "img":"http://img0.pcauto.com.cn/pcauto/1310/16/3233041_Img388290093_thumb.jpg",
        "title":"图集",
        "view":"album-list/",
        "url":""
    }
]

}}}


== 3.开发时间、负责人、进度和实现方式==

||批次||= 页面 =||= 涉及MROBOT接口 =||=是否需要[[BR]]HTML切图 =||= 需配合的接口负责人[[BR]]及进度 =||= 接口开发[[BR]]预计时间 =||=接口进度（百分比）=||=接口实际[[BR]]完成时间=||=实现方式=||
||第一批|| 首页 ||2.1 [#point201 左侧主菜单 ] ||- || - ||  - || 已上线 || - || madmin配置