APP接口基本约定

------------------------------------------------------------------------------------------------------------------

通用接口请求参数

req_enc=utf-8  			请求参数编码

resp_enc=utf-8 			响应返回编码

common_session_id=xxxx          用户登录凭证,如果接口需要登陆则生效

pageNo=1		 	请求页码(>=1),如果接口返回有分页处理则生效

pageSize=20	 		请求页长度,默认20,如果接口返回有分页处理则生效


常用的参数字段，统一使用AppControllerStatic.java中定义的静态变量。

------------------------------------------------------------------------------------------------------------------

通用接口返回参数

total:18			返回记录总条数,如果接口返回有分页处理则生效

pageNo:1			返回页码(>=1),如果接口返回有分页处理则生效

pageSize:20			返回页长度,如果接口返回有分页处理则生效

code:0                          返回0：；操作成功 1：操作失败

message:操作成功                默认返回"操作成功 "或者"操作失败",也可以只定义返回内容

data:[]                         返回数组 
 
version:v3.0--v4.0(Latest)      返回【调用的版本号--推荐使用的最新版本号】


常用的Json结果返回，统一使用AppControllerStatic.java中定义好的操作方法。

printSuccessMsg():不带参数默认是“操作成功”， 带string参数就自定义的信息

printErrorMsg():不带参数默认是“操作失败”， 带string参数就自定义的信息

------------------------------------------------------------------------------------------------------------------

名词解释

接口URL:   接口URL

接口说明:  描述接口的应用场景

请求参数： 参数名=xxx

是否登录： 是|否,表示接口是否要登陆才能访问

是否分页:  是|否,表示返回的 列表有分页处理

缓存时间： xx,设置Response Http Headers Cache-Control:max-age=xx(单位/秒)


全局接口返回格式：json

------------------------------------------------------------------------------------------------------------------

接口URL定义

a.URL前缀为/appapi/

b.APP调用的接口URL在action.do前面必须带有版本号

例如：/appapi/club/v3.0/listTongChengClubs.do