wiki:baby3_developers/interface

Version 1 (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

二.接口列表