Changes between Version 4 and Version 5 of appApiRules

Timestamp:

12/01/2014 03:57:43 PM (11 years ago)

Author:

zhouruxuan

Comment:

--

appApiRules

@@ -5 +5 @@
 ------------------------------------------------------------------------------------------------------------------
 
-通用接口请求参数
+'''通用接口请求参数'''
 
 req_enc=utf-8                   请求参数编码
@@ -18 +18 @@
 
 
-常用的参数字段，统一使用AppControllerStatic.java中定义的静态变量。
+'''常用的参数字段'''
+
+userId : 用户ID
+
+clubId : 车友会ID
+
+provinceId : 省份ID
+
+cityId : 城市ID
+
+brandId : 品牌ID
+
+seriesId : 车系ID
+
+xssEncode : 0 原内容 1 过滤xss
+
+callback : 回调方法
+
+pageNo : 第几分页
+
+pageSize : 每页数量
+
+pageCount : 总页数
+
+total : 返回数据总数
 
 ------------------------------------------------------------------------------------------------------------------
 
-通用接口返回参数
+'''通用接口返回参数'''
 
-total:18                        返回记录总条数,如果接口返回有分页处理则生效
+userId : 用户ID
 
-pageNo:1                        返回页码(>=1),如果接口返回有分页处理则生效
+clubId : 车友会ID
 
-pageSize:20                     返回页长度,如果接口返回有分页处理则生效
+provinceId : 省份ID
 
-code:0                          返回0：；操作成功 1：操作失败
+cityId : 城市ID
 
-message:操作成功                默认返回"操作成功 "或者"操作失败",也可以只定义返回内容
+brandId : 品牌ID
+
+seriesId : 车系ID
+
+xssEncode : 0 原内容 ;1 过滤xss
+
+callback : 回调方法
+
+pageNo :     返回页码(>=1),如果接口返回有分页处理则生效''(注：pageNo最大值为100）''
+
+pageSize :   返回页长度,如果接口返回有分页处理则生效''（注：pageSize最大值为100）''
+
+pageCount :  返回总页数,如果接口返回有分页处理则生效
+
+total :      返回记录总条数,如果接口返回有分页处理则生效
+
+code:0       返回0：操作成功; 1：操作失败
+
+message:     操作成功  默认返回"操作成功 "或者"操作失败",也可以只定义返回内容
  
-version:v3.0--v4.0(Latest)      返回【调用的版本号--推荐使用的最新版本号】
+version:v3.0 返回调用的版本号，如果是最新的版本返回如 v3.0(Latest)
 
 
-常用的Json结果返回，统一使用AppControllerStatic.java中定义好的操作方法。
-
-printSuccessMsg():不带参数默认是“操作成功”， 带string参数就自定义的信息
-
-printErrorMsg():不带参数默认是“操作失败”， 带string参数就自定义的信息
 
 ------------------------------------------------------------------------------------------------------------------
 
-名词解释
+'''名词解释'''
 
 接口URL:   接口URL
@@ -64 +101 @@
 ------------------------------------------------------------------------------------------------------------------
 
-接口URL定义
+'''接口URL定义'''
 
 a.URL前缀为/appapi/
 
-b.APP调用的接口URL在action.do前面必须带有版本号
+b.APP调用的接口URL在''/appapi/''后面必须带有版本号
 
-例如：/appapi/3.0/clubs/123
+例如：/appapi/3.0/clubs/123.do
 }}}