Changes between Version 2 and Version 3 of pclady_news1.2_api


Ignore:
Timestamp:
07/20/2015 11:38:16 AM (11 years ago)
Author:
hezhenwei1
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • pclady_news1.2_api

    v2 v3  
    11[[TOC]] 
    22 
    3 =太平洋时尚网1.2.0接口文档 = 
    4 >mrobot代理环境说明：  
    5      192.168.10.198：1080(192.168.74.80)[[BR]]  
    6      192.168.10.199 端口为 1080 连的是dev40的开发环境（192.168.75.40）[[BR]]  
    7      ps:未到qa阶段，连开发环境调试（若仅做代理，mrobot不存在真正的处理文件，只作转发的功能） [[BR]]  
    8 == 1.广告 == 
    9 ---------- 
     3== 一.基本约定 == 
    104 
     5{{{ 
     6  1.开发机、测试机代理地址： 
     7  mrobot开发机代理：192.168.10.199  端口：1080 
     8  mrobot测试机代理：192.168.10.198  端口：1080 
     9   
     10  2.当接口处理正常时，HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。 
     11   
     12  3.当接口处理异常时，HTTP STATUS CODE 返回非200，并且给出具体的错误信息。 
     13      { 
     14         "desc":"给用户的提示放在这里" 
     15      } 
     16       
     17  4.接口默认的字符编码是UTF-8，接口需要实现对req-enc和resp-enc参数的支持。 
     18   
     19  5.所有有写操作的数据接口，必须用POST方式提交，在接口里需要判断提交方式，拒绝GET的调用请求。 
     20   
     21  6.接口中的JSON字符串，key都用双引号("")包裹，value是字符串类型时，也用双引号("")包裹；是数字类型时，不用引号 
     22   
     23  7.需要分页的接口，统一返回以下字段:  pageNo,pageSize,total 
     24   
     25  8.涉及接口都增加请求参数：v = 220  //版本号(数字) 
    1126 
    12 === 1.1精选推荐 === 
    13 '''(mrobot已完成，请连开发机进行测试)'''[[BR]] 
    14 开发环境：http://dev15.pclady.com.cn/app/essenceList.jsp  [[BR]] 
    15 线上环境：http://plastic.pclady.com.cn/app/essenceList.jsp [[BR]] 
    16 mrobot地址：  http://mrobot.pclady.com.cn/s-900/yimei/cms/index.xsp 
     27  9.发帖，回帖中status字段值的含义如下： 
    1728 
    18 **说明** 
     29        STATUS_ERROR = -1;                              //错误 
     30        STATUS_SUCCESS = 0;                             //成功 
     31        STATUS_NO_RIGHT = 1;                            //没有权限 
     32        STATUS_PARAM_WRONG = 2;                         //参数错误 
     33        STATUS_CONTENT_OVERFLOW = 3;                    //内容超出长度 
     34        STATUS_EXISTS = 4;                              //数据已经存在 
     35        STATUS_NOT_FOUND = 5;                           //数据查找不到 
     36        STATUS_NO_LOGIN = 6;                            //没有登录 
     37        STATUS_USER_LOCK = 7;                           //用户被锁 
    1938 
    20 >广告接口 
     39        当status不等于0时，具体原因参照message字段的说明。 
     40}}} 
    2141 
    22 **缓存时间** 
     42== 二.接口列表 == 
     43=== 1.0 广告 === 
     44{{{ 
     45  备注：获取广告数据（接口已完成，使用请连开发机代理） 
     46  mrobot接口URL：http://mrobot.pcbaby.com.cn/v3/ad 
     47  后端接口URL：http://ivy.pconline.com.cn/adpuba/show?id=pc.khd.zx.btxfldxj.&media=js 
    2348 
    24 >15分钟 
    25  
    26 **提交方式** 
    27  
    28 > GET 
    29  
    30 **是否登录** 
    31  
    32 > 否 
    33  
    34 **数据来源** 
    35  
    36 >整形库编辑后台 
    37  
    38 **参数** 
    39  
     49  HTTP请求方式：GET 
     50  是否需要登录：否 
     51  返回格式：JSON 
     52  缓存方式：无 
     53  缓存时间：无 
     54  请求参数： 
    4055||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||=说明=|| 
    4156||pageNo||页数||int||1||是||= 为1时返回主页的内容 =|| 
    … …  
    4459||city||城市||String||""||否||= mrobot请求主页数据时用到 =|| 
    4560||project||感兴趣的项目||String||""||否||= mrobot请求主页数据时用到 =|| 
    46 **返回** 
    4761 
    48 {{{#!java 
     62  返回结果: 
    4963{ 
    50   "status":0, 
    51   "msg":"请求成功", 
    52   "pageNo": 1,  
    53   "pageSize": 20, 
    54   "total": 100, 
    55   "sysTime":"系统当前时间YYYY-MM-DD HH:mm:ss 
    56   "data":[{  
    57     "contentID":"", 
    58     "nickName":"",  
    59     "userID":"",  
    60     "type":””,  
    61     "imageUrl":"",  
    62     "title":"",  
    63     "commentCount":1, 
    64     "laudCount":1, 
    65     "hasLaud":1", 
    66     "isExample":0 
    67     } 
    68   ], 
    69   "index":{ 
    70  
    71 } 
    7264} 
    7365 
    74 }}} 
    75 **返回参数说明** 
     66 返回结果说明: 
    7667||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=|| 
    7768||= contentID =||= 内容ID=||= title =||=标题=|| 
    … …  
    8273||= isExample =||当type==2时，要判断是否为旧案例数据，isExample==1时为旧案例数据，默认为0||==||==|| 
    8374 
     75}}} 
     76 
     77 
     78 
     79 
    8480 
    8581----------