wiki:baby/interface

Version 2 (modified by hejingdong, 12 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是字符串类型时,也用双引号("")包裹;是数字类型时,不用引号

二.接口列表

1.0首页

  备注:首页
  请求URL:http://
  HTTP请求方式:get
  是否需要登录:否
  返回格式:JSON
  缓存方式:无
  缓存时间:无
  请求参数:
  status:1备孕,2怀孕,3育儿
  weeks:第几周
  
  返回参数:
  {
   focus:[
     {
       id:
       image:
       title:
       type:论坛(1列表、2终端);亲子学院(3列表、4终端);活动(5列表、6终端);工具(7终端);食谱(8终端);资讯(9终端);问答(10终端);百科(11终端)
     }
   ],
   recommend:[
     {
       id:
       image:
       title:
       type:论坛(1列表、2终端);亲子学院(3列表、4终端);活动(5列表、6终端);工具(7终端);食谱(8终端);资讯(9终端);问答(10终端);百科(11终端)
     }
   ],
   hotChannels:[
    {
      id:
      name:
      type:
      image:
    }
   ]
  }

2.0工具

2.1工具首页

  备注:工具类首页
  请求URL:http://
  HTTP请求方式:get
  是否需要登录:否
  返回格式:html页面
  缓存方式:无
  缓存时间:无
  请求参数:

  协议:
  点击二胎政策查询,pcbabybible://policy-search
  点击备孕日历,pcbabybible://pregnancy-calendar
  点击其他工具,正常HTTP协议

2.2其他工具

  备注:其他工具
  请求URL:http://
  HTTP请求方式:get
  是否需要登录:否
  返回格式:html页面
  缓存方式:无
  缓存时间:无
  请求参数:

3.0每日知识

3.0每日知识首页

  备注:每日知识首页
  请求URL:http://
  HTTP请求方式:get
  是否需要登录:否
  返回格式:JSON
  缓存方式:无
  缓存时间:无
  请求参数:
  status:1备孕,2怀孕,3育儿
  weeks:第几周
  
  返回参数:
  {
   tips:"",
   cookbook:[
    {
      id:
      image:
      title:
      des:
    }
   ],
   timeline:[
      {
        "title":"优生优育",
        "section":[
           {
              id:
              image:
              title:
              type:论坛(1列表、2终端);亲子学院(3列表、4终端);活动(5列表、6终端);工具(7终端);食谱(8终端);资讯(9终端);问答(10终端);百科(11终端)
           },
           {
              id:
              image:
              title:
              type:
           }
        ]
      },
      {
        "title":"生男生女",
        "section":[
           {
              id:
              image:
              title:
              type:
           },
           {
              id:
              image:
              title:
              type:
           }
        ]
      }
   ]
  }

3.1周期

  备注:周期
  请求URL:http://
  HTTP请求方式:get
  是否需要登录:否
  返回格式:JSON
  缓存方式:无
  缓存时间:无
  请求参数:
  status:1备孕,2怀孕,3育儿
  返回参数:
  {
   weeks:[
    {
     num:1,
     tips:"多吃含钙食物"
    },
    {
     num:1,
     tips:"多吃含tie食物"
    }
   ]
  }

3.1食谱列表

  备注:食谱列表
  请求URL:http://
  HTTP请求方式:get
  是否需要登录:否
  返回格式:JSON
  缓存方式:无
  缓存时间:无
  请求参数:
  status:1备孕,2怀孕,3育儿
  type:1每日知识,2食谱
  weeks:第几周
  返回参数
  {
   id:
   cookbook:[
     [//第一天
     {
       id:
       name:
       image:
       des:
       time:(早餐,午餐、晚餐)
     },
     {
       id:
       name:
       image:
       des:
       time:(早餐,午餐、晚餐)
     }, {
       id:
       name:
       image:
       des:
       time:(早餐,午餐、晚餐)
     }
     
     ], 
     [//第二天
     {
       id:
       name:
       image:
       des:
       time:(早餐,午餐、晚餐)
     },
     {
       id:
       name:
       image:
       des:
       time:(早餐,午餐、晚餐)
     }, {
       id:
       name:
       image:
       des:
       time:(早餐,午餐、晚餐)
     }
     ]
   ]
  }

3.2食谱详情

  备注:食谱详情
  请求URL:http://
  HTTP请求方式:get
  是否需要登录:否
  返回格式:JSON
  缓存方式:无
  缓存时间:无
  请求参数:
  id:食谱id
  返回参数
  {
   id:
   name:
   picDes:[
    {
       id:
       image:
       des:
    }
   ]
  }

Attachments