wiki:pcauto_4.0.0/interface

Version 9 (modified by leijingtang, 13 years ago) (diff)

--

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的最顶部,实现类似下面的代码:

        String queryString = request.getQueryString();
        String requestEncoding = getParam(queryString,"req_enc");
        String responseEncoding = getParam(queryString,"resp_enc");
        if(isNotBlank(requestEncoding)){
            request.setCharacterEncoding(requestEncoding);
        }
        if(isNotBlank(responseEncoding)){
            response.setCharacterEncoding(responseEncoding);
        }

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

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

2.接口列表

2.1 头条

    url:
       汽车网:待定
       电脑网:待定
    作用:获取头条数据
    使用范围:电脑网app、汽车网app

    HTTP请求方式:get                         
    是否需要登录:是                          
    请求参数:
          pageSize  // 每页加载量,默认20条
          pageNo    // 页码
    返回参数:

"contentList": [
{
"infoCount": 93,     // 如果是文章则为评论数,如果是帖子则为楼层数,如果是图集则为图片张数
"contentId": 2965125,     // 文章、帖子或者图集id
"objectId":2965125,      // 对象id,赞/踩用到的数据
"type":"",                // 类型,目前包含article, album和topic三个值
"image": "http://img0.pcauto.com.cn/pcauto/1308/29/g_2965125_1377744114989_240x160.jpg",   //导读图
"title": "[直播]成都车展探馆:奥迪RS5 Coupe亮相",      //内容标题
"channel":"所属栏目"    // 所属栏目
},
...
],
"focusList":[
{
"image:":"http://img0.pcauto.com.cn/pcauto/1308/29/g_2965125_1377744114989_240x160.jpg",
"contentId":111111  // 同上
"objecetId": 111111  // 同上
}
]

2.2 车系聚合页

    url:
       汽车网:待定
       电脑网:待定
    作用:获取某个车系的聚合内容
    使用范围:电脑网app、汽车网app

    HTTP请求方式:get                         
    是否需要登录:是                          
    请求参数:
          pageSize  // 每页加载量,默认20条
          pageNo    // 页码
          serialId     // 车系id
    返回参数:
{
"focus":"http://xxxx.png",
"contentList": [
{
"infoCount": 93,     // 如果是文章则为评论数,如果是帖子则为楼层数,如果是图集则为图片张数
"contentId": 2965125,     // 文章、帖子或者图集id
"objectId":2965125,      // 对象id,赞/踩用到的数据
"type":"",                // 类型,目前包含article, album和topic三个值
"image": "http://img0.pcauto.com.cn/pcauto/1308/29/g_2965125_1377744114989_240x160.jpg",   //导读图
"title": "[直播]成都车展探馆:奥迪RS5 Coupe亮相",      //内容标题
"channel":"所属栏目"    // 所属栏目
},
...
]
}