wiki:jianxun/cmsMagazineShelfInterface

Version 2 (modified by xieweijie, 13 years ago) (diff)

合并接口文档，修改描述

基本约定

1.当接口处理正常时，HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。

2.接口默认的字符编码是UTF-8

1.书架接口

书架接口地址:
 | 家居ipad2
 | 家居ipad3
修改包括

1.增加推荐按杂志字段，原有magazine字段不变

2.推荐杂志信息thumb字段为新图片链接，防止图片模糊

3.推荐杂志信息增加pics字段，内页图片链接数组，返回数为3或6或9张，由后台系统配置

4.推荐杂志其余信息与magazines返回对应杂志信息一致 

使用范围:家居杂志iPad

url:http://reader.pchouse.com.cn/pchousemag/ipad2/json/magazines.json

请求方法:GET

返回例子
{
        "recommendedMagazine":
        {
				"id":"234",
				"magazine":"PChouse",
				"publisher":"家居网",
				"volume":"0",
				"bookDownloadStatus":"1",
				"issue":"9月刊",
				"publishTime":"2013-08-13 17:45:15",
				"cover":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/cover\/234-big.jpg",
				"thumb":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/cover\/234-XXXX.jpg",//原来magazine压缩的图会显示模糊
				"dir-ver":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/content\/234-ver-dir.jpg",
				"summary":"",
				"url":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/234.zip",
				"base_url":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/seperatepack\/234\/234-base.zip",
				"base_url_prefix":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/seperatepack\/234\/",
				"deviceType":"0",
				"md5":"a965faa5856a031c1a2153c8cd57e6bb",
				"bestTopicUrl":"",
				"size":"14.05MB",
                                "pics":[
                                   "http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/innterPagePic\1.png",
                                   "http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/innterPagePic\2.png",
                                   "http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/innterPagePic\3.png",
                                   ...
                                 ]//推荐杂志显示内页图片，根据配置返回3张、6张或9张
			},
	"magazines":
		[
			{
				"id":"234",
				"magazine":"PChouse",
				"publisher":"家居网",
				"volume":"0",
				"bookDownloadStatus":"1",
				"issue":"9月刊",
				"publishTime":"2013-08-13 17:45:15",
				"cover":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/cover\/234-big.jpg",
				"thumb":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/cover\/234-small.jpg",
				"dir-ver":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/content\/234-ver-dir.jpg",
				"summary":"",
				"url":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/234.zip",
				"base_url":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/seperatepack\/234\/234-base.zip",
				"base_url_prefix":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/seperatepack\/234\/",
				"deviceType":"0",
				"md5":"a965faa5856a031c1a2153c8cd57e6bb",
				"bestTopicUrl":"",
				"size":"14.05MB"
			},
			{
				"id":"119",
				"magazine":"PChouse",
				"publisher":"家居网",
				"volume":"0",
				"bookDownloadStatus":"1",
				"issue":"test11",
				"publishTime":"2013-08-12 14:22:43",
				"cover":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/cover\/119-big.jpg",
				"thumb":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/cover\/119-small.jpg",
				"dir-ver":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/content\/119-ver-dir.jpg",
				"summary":"",
				"url":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/119.zip",
				"base_url":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/seperatepack\/119\/119-base.zip",
				"base_url_prefix":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/seperatepack\/119\/",
				"deviceType":"0",
				"md5":"f1937bed3bc91d73a3a620b2cbc9f82e",
				"bestTopicUrl":"",
				"size":"8.14MB"
			},
                        ...
               ]
}

2.瀑布流评论接口

接口地址
 http://mrobot.pchouse.com.cn/v3/cmt/topics_reverse 接口参数

pageSize 每页评论数
pageNo 第几页
url 文章评论url，例如 http://magazine.pchouse.com.cn/230/2229

返回格式

{
    "total": 33, 评论总条数,回复评论的评论不当作评论数
    "pageNo": 1, 返回第几页
    "pageSize": 500, 每页多少条
    "data": [
             {
             "id": 25819160, 评论id
             "content": "好评", 评论内容
             "createTime": "2013-08-01 09:25:17", 评论创建时间
             "support": 0, 支持数
             "floor": 34, 楼层
             "nickName": "家居杂志iPad客户端网友", 评论昵称
             "face":"", 评论用户头像,没头像则返回""
             "replyRefs": [
                          {
                          "content": "这期闪退的厉害！！！怎么回事！！", 回复内容
                          "id": 25817587, 回复评论id
                          "createTime": "2013-07-31 18:24:09", 回复创建时间
                          "floor": 35, 回复楼层，对应旧评论结构回复楼层
                          "support": 2, 支持数
                          "nickName": "家居杂志iPad客户端网友", 回复用户昵称
                          "face":"", 回复用户头像,没头像则返回""
                          "toReplyNickname":"被回复用户昵称" 被回复用户昵称，相当于旧结构的引用楼层用户昵称
                          "toReplyFloor":34 被回复用户楼层，相当于旧结构的引用楼层
                          },
                          ...
                          ]
             },
             ...
             ]
}

评论转换规则

1.评论倒序遍历，没有回复引用评论当作一般评论，加入返回评论数组
2.有回复引用评论递归整理为第一个被引用评论包含引用楼层，如
{
    "id": 25819160,
    "content": "板凳",
    "floor": 35,
    "nickName": "板凳网友",
    "replyRef": {
        "content": "沙发",
        "id": 25817587,
        "floor": 34,
        "nickName": "沙发网友",
...
    },
...
}
转换成
{
    "id": 25817587,
    "content": "沙发",
    "floor": 34,
    "nickName": "沙发网友",
    "replyRefs": [
        {
            "content": "板凳",
            "id": 25819160,
            "floor": 35,
            "nickName": "板凳网友",
            "toReplyNickname": "沙发网友",
            "toReplyFloor": 34,
        }
    ]
}
3.过滤已存在回复评论，如遍历到例子当中的“沙发”评论则自动过滤
{
    "data": [
        {
            "id": 25819160,
            "content": "板凳",
            "floor": 35,
            "nickName": "板凳网友",
            "replyRef": {
                "content": "沙发",
                "id": 25817587,
                "floor": 34,
                "nickName": "沙发网友"
            }
        },
        {
            "content": "沙发",
            "id": 25817587,
            "floor": 34,
            "nickName": "沙发网友"
        }
    ]
}
转换成
{
    "data": [
        {
            "id": 25817587,
            "content": "沙发",
            "floor": 34,
            "nickName": "沙发网友",
            "replyRefs": [
                {
                    "content": "板凳",
                    "id": 25819160,
                    "floor": 35,
                    "nickName": "板凳网友",
                    "toReplyNickname": "沙发网友",
                    "toReplyFloor": 34
                }
            ]
        }
    ]
}

以上数据使用以下接口返回
http://cmt.pchouse.com.cn/action/comment/list_new_json.jsp?noUbb=true&pageSize=500&pageNo=1&url=http://magazine.pchouse.com.cn/230/2229
其中用户头像字段face上述接口并没有提供，需要另外查找