wiki:appApiRules

Version 5 (modified by zhouruxuan, 11 years ago) (diff)

--

APP接口基本约定

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

'''通用接口请求参数'''

req_enc=utf-8  			请求参数编码

resp_enc=utf-8 			响应返回编码

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

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

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


'''常用的参数字段'''

userId : 用户ID

clubId : 车友会ID

provinceId : 省份ID

cityId : 城市ID

brandId : 品牌ID

seriesId : 车系ID

xssEncode : 0 原内容 1 过滤xss

callback : 回调方法

pageNo : 第几分页

pageSize : 每页数量

pageCount : 总页数

total : 返回数据总数

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

'''通用接口返回参数'''

userId : 用户ID

clubId : 车友会ID

provinceId : 省份ID

cityId : 城市ID

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 返回调用的版本号,如果是最新的版本返回如 v3.0(Latest)



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

'''名词解释'''

接口URL:   接口URL

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

请求参数: 参数名=xxx

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

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

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


全局接口返回格式:json

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

'''接口URL定义'''

a.URL前缀为/appapi/

b.APP调用的接口URL在''/appapi/''后面必须带有版本号

例如:/appapi/3.0/clubs/123.do