wiki:baby3_developers/interface

Version 2 (modified by lianchijin, 11 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是字符串类型时,也用双引号("")包裹;是数字类型时,不用引号
  
  6.需要分页的接口,统一返回以下字段:  pageNo,pageSize,total

二.接口列表

1.0首页

  备注:首页接口,在V2.0接口的基础上更改,根据参数 v >=3.0.0,则焦点图增加视频类文章页、问答专栏详情的推广,热门栏目增加崔玉涛专栏
  接口开发:
  请求URL:
     备孕首页:http://mrobot.pcbaby.com.cn/v2/qzbd/home/1
     怀孕首页:http://mrobot.pcbaby.com.cn/v2/qzbd/home/2
     育儿首页:http://mrobot.pcbaby.com.cn/v2/qzbd/home/3
  HTTP请求方式:get
  是否需要登录:否
  返回格式:JSON
  缓存方式:无
  缓存时间:无
  请求参数:
  v = 3.0.0   //版本号
  
  返回参数:
  {
   focus:[  //焦点图数据(增加视频类文章页、问答专栏详情的推广)
     {
       id:
       image:
       title:
       type:论坛(1列表、2终端);亲子学院(3列表、4终端);活动(5列表、6终端);工具(7终端);食谱(8终端);资讯(9终端);问答(10终端);百科(11终端);崔玉涛视频(12视频文章终端);专栏详情(13)
       url:(活动、工具终端打开需要url,不需要时为空字符串)
     }
   ],
   recommend:[   //四个推荐位内容
     {
       id:
       image:
       title:
       type:论坛(1列表、2终端);亲子学院(3列表、4终端);活动(5列表、6终端);工具(7终端);食谱(8终端);资讯(9终端);问答(10终端);百科(11终端)
       url:(活动、工具终端打开需要url,不需要时为空字符串)
     }
   ],
   recommendChannel:[    //热门栏目(增加崔玉涛专栏)
    {
      id:
      name:  //根据栏目名称跳转至对应模块
      type:      
      image:
    }
   ],
   topFocus: [ //焦点图广告
    {
      cc-uri: "",
      image: "http://www1.pcbaby.com.cn/appguanggao/1.jpg?IVY_LEVEL_1?481456_307375",
      seq: 1,
      title: "广告",
      to-uri: "http://ivy.pconline.com.cn/adpuba/click?adid=307375&id=test.gjz.zicong.",
      updateAt: 1408678837215,
      vc-uri: "none"
    }
   ]
  }