Changes between Version 1 and Version 2 of jianxun/cmsMagazineShelfInterface


Ignore:
Timestamp:
08/14/2013 11:03:25 AM (13 years ago)
Author:
xieweijie
Comment:

合并接口文档，修改描述

Legend:

Unmodified
Added
Removed
Modified

  • jianxun/cmsMagazineShelfInterface

    v1 v2  
    1 书架接口返回[[BR]] 
    2 增加推荐按杂志字段，原有magazine字段不变[[BR]] 
    3 推荐杂志信息除thumb字段与增加的pics外，其余信息与magazine对应杂志信息一致 
    4 {{{ 
     1== 基本约定 == 
     2 
     3{{{ 
     41.当接口处理正常时，HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。 
     5 
     62.接口默认的字符编码是UTF-8 
     7}}} 
     8 
     9== 1.书架接口 == 
     10 
     11书架接口地址:[[BR]] 
     12[http://reader.pchouse.com.cn/pchousemag/ipad2/json/magazines.json | 家居ipad2][[BR]] 
     13[http://reader.pchouse.com.cn/pchousemag/ipad3/json/magazines.json | 家居ipad3][[BR]] 
     14修改包括 
     15 
     161.增加推荐按杂志字段，原有magazine字段不变 
     17 
     182.推荐杂志信息thumb字段为新图片链接，防止图片模糊 
     19 
     203.推荐杂志信息增加pics字段，内页图片链接数组，返回数为3或6或9张，由后台系统配置 
     21 
     224.推荐杂志其余信息与magazines返回对应杂志信息一致 
     23 
     24{{{ 
     25使用范围:家居杂志iPad 
     26 
     27url:http://reader.pchouse.com.cn/pchousemag/ipad2/json/magazines.json 
     28 
     29请求方法:GET 
     30 
     31返回例子 
    532{ 
    633        "recommendedMagazine": 
    … …  
    1441                                "publishTime":"2013-08-13 17:45:15", 
    1542                                "cover":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/cover\/234-big.jpg", 
    16                                 "thumb":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/cover\/234-XXXX.jpg",//另外的图，原来magazine压缩的图会显示模糊 
     43                                "thumb":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/cover\/234-XXXX.jpg",//原来magazine压缩的图会显示模糊 
    1744                                "dir-ver":"http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/content\/234-ver-dir.jpg", 
    1845                                "summary":"", 
    … …  
    2552                                "size":"14.05MB", 
    2653                                "pics":[ 
    27                                    "http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/cover\1.png", 
    28                                    "http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/cover\2.png", 
    29                                    "http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/cover\3.png", 
    30                                    "http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/cover\4.png", 
     54                                   "http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/innterPagePic\1.png", 
     55                                   "http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/innterPagePic\2.png", 
     56                                   "http:\/\/192.168.11.20:8888\/magazine\/preview\/ipad2\/innterPagePic\3.png", 
    3157                                   ... 
    3258                                 ]//推荐杂志显示内页图片，根据配置返回3张、6张或9张 
    … …  
    75101                        }, 
    76102                        ... 
    77                    ] 
    78 } 
    79  
    80 }}} 
     103               ] 
     104} 
     105}}} 
     106 
     107== 2.瀑布流评论接口 == 
     108接口地址[[BR]] 
     109http://mrobot.pchouse.com.cn/v3/cmt/topics_reverse 
     110接口参数[[BR]] 
     111{{{ 
     112pageSize 每页评论数 
     113pageNo 第几页 
     114url 文章评论url，例如 http://magazine.pchouse.com.cn/230/2229 
     115}}} 
     116返回格式[[BR]] 
     117{{{ 
     118{ 
     119    "total": 33, 评论总条数,回复评论的评论不当作评论数 
     120    "pageNo": 1, 返回第几页 
     121    "pageSize": 500, 每页多少条 
     122    "data": [ 
     123             { 
     124             "id": 25819160, 评论id 
     125             "content": "好评", 评论内容 
     126             "createTime": "2013-08-01 09:25:17", 评论创建时间 
     127             "support": 0, 支持数 
     128             "floor": 34, 楼层 
     129             "nickName": "家居杂志iPad客户端网友", 评论昵称 
     130             "face":"", 评论用户头像,没头像则返回"" 
     131             "replyRefs": [ 
     132                          { 
     133                          "content": "这期闪退的厉害！！！怎么回事！！", 回复内容 
     134                          "id": 25817587, 回复评论id 
     135                          "createTime": "2013-07-31 18:24:09", 回复创建时间 
     136                          "floor": 35, 回复楼层，对应旧评论结构回复楼层 
     137                          "support": 2, 支持数 
     138                          "nickName": "家居杂志iPad客户端网友", 回复用户昵称 
     139                          "face":"", 回复用户头像,没头像则返回"" 
     140                          "toReplyNickname":"被回复用户昵称" 被回复用户昵称，相当于旧结构的引用楼层用户昵称 
     141                          "toReplyFloor":34 被回复用户楼层，相当于旧结构的引用楼层 
     142                          }, 
     143                          ... 
     144                          ] 
     145             }, 
     146             ... 
     147             ] 
     148} 
     149}}} 
     150评论转换规则[[BR]] 
     151{{{ 
     1521.评论倒序遍历，没有回复引用评论当作一般评论，加入返回评论数组 
     1532.有回复引用评论递归整理为第一个被引用评论包含引用楼层，如 
     154{ 
     155    "id": 25819160, 
     156    "content": "板凳", 
     157    "floor": 35, 
     158    "nickName": "板凳网友", 
     159    "replyRef": { 
     160        "content": "沙发", 
     161        "id": 25817587, 
     162        "floor": 34, 
     163        "nickName": "沙发网友", 
     164... 
     165    }, 
     166... 
     167} 
     168转换成 
     169{ 
     170    "id": 25817587, 
     171    "content": "沙发", 
     172    "floor": 34, 
     173    "nickName": "沙发网友", 
     174    "replyRefs": [ 
     175        { 
     176            "content": "板凳", 
     177            "id": 25819160, 
     178            "floor": 35, 
     179            "nickName": "板凳网友", 
     180            "toReplyNickname": "沙发网友", 
     181            "toReplyFloor": 34, 
     182        } 
     183    ] 
     184} 
     1853.过滤已存在回复评论，如遍历到例子当中的“沙发”评论则自动过滤 
     186{ 
     187    "data": [ 
     188        { 
     189            "id": 25819160, 
     190            "content": "板凳", 
     191            "floor": 35, 
     192            "nickName": "板凳网友", 
     193            "replyRef": { 
     194                "content": "沙发", 
     195                "id": 25817587, 
     196                "floor": 34, 
     197                "nickName": "沙发网友" 
     198            } 
     199        }, 
     200        { 
     201            "content": "沙发", 
     202            "id": 25817587, 
     203            "floor": 34, 
     204            "nickName": "沙发网友" 
     205        } 
     206    ] 
     207} 
     208转换成 
     209{ 
     210    "data": [ 
     211        { 
     212            "id": 25817587, 
     213            "content": "沙发", 
     214            "floor": 34, 
     215            "nickName": "沙发网友", 
     216            "replyRefs": [ 
     217                { 
     218                    "content": "板凳", 
     219                    "id": 25819160, 
     220                    "floor": 35, 
     221                    "nickName": "板凳网友", 
     222                    "toReplyNickname": "沙发网友", 
     223                    "toReplyFloor": 34 
     224                } 
     225            ] 
     226        } 
     227    ] 
     228} 
     229 
     230以上数据使用以下接口返回 
     231http://cmt.pchouse.com.cn/action/comment/list_new_json.jsp?noUbb=true&pageSize=500&pageNo=1&url=http://magazine.pchouse.com.cn/230/2229 
     232其中用户头像字段face上述接口并没有提供，需要另外查找 
     233}}}