Changes between Version 1 and Version 2 of pcauto_club_2.0.0/api

Timestamp:

04/04/2014 11:59:34 AM (12 years ago)

Author:

maozhijun

Comment:

--

pcauto_club_2.0.0/api

@@ -3 +3 @@
 == 1.基本约定 ==
 {{{
-接口通用参数
-req_enc=utf-8(必须放url后面)
-resp_enc=utf-8(必须放url后面)
-common_session_id=xxxx(以cookies中的优先)
+通用接口请求参数:
+req_enc=utf-8                                   请求参数编码
+resp_enc=utf-8                                  响应返回编码
+common_session_id=xxxx                  用户登录凭证,如果接口需要登陆则生效
+pageNo=1                                        请求页码(>=1),如果接口返回有分页处理则生效
+pageSize=       20                                      请求页长度,默认20,如果接口返回有分页处理则生效
+
+通用接口返回参数:
+total:18                                                返回记录总条数,如果接口返回有分页处理则生效
+pageNo:1                                                返回页码(>=1),如果接口返回有分页处理则生效
+pageSize:20                                     返回页长度,如果接口返回有分页处理则生效
 
 测试接口前缀:http://dev18.pcauto.com.cn:8003
 上线接口前缀:http://club.pcauto.com.cn
 
+名词解释
 接口URL: 接口URL
-必填参数：参数名=xxx(多种情况用括号解析)
-非必填参数：参数名=xxx(多种情况用括号解析)
-说明文档参数：添加某特定参数可以直接看接口文档
-是否需要登录：是,否
-返回格式：json,ssi,xml
-缓存方式：接口缓存，对象缓存
-缓存时间：缓存时间
-返回结果：结果可能情况
+接口说明:   描述接口的应用场景
+请求参数：参数名=xxx
+是否登录：是|否,表示接口是否要登陆才能访问
+缓存时间：xx,设置Response Http Headers Cache-Control:max-age=xx(单位/秒)
+返回结果：成功返回结果示例
+
+全局接口返回格式：json
+
+全局接口错误格式:
+{
+        code:1001                                       错误代码
+        msg: “您还没有登陆”           错误提示
+}
 }}}
 
 
 == 2.接口列表 ==
+
+===2.1车友会详情接口===
+
+===2.2车友会信息与已加入的车友会权限列表接口===
+
+===2.3首页车友会列表接口===
+
+===2.4车友会搜索接口===
+
+===2.5车友动态接口===
+
+===2.6车友会相册列表接口===
+
+===2.7相册图片列表接口===
+
+===2.8上传图片接口===
+
+===2.9创建相册接口===
+
+===2.10车友会活动列表接口===
+
+===2.11活动详情页面===
+
+===2.12报名人员页面===
+
+===2.13活动报名接口===
+
+===2.14车友会成员列表接口===
+
+===2.15车友会成员管理接口===
+
+===2.16车友会入退会接口===
+
+===2.17车友会留言列表接口===
+
+===2.18创建留言与回复留言接口===
+
+===2.19创建车友会接口===
+
+===2.20修改车友会接口===
+
+===2.21域名合法校验接口===
+
+===2.22车友会名合法校验接口===
+
+===2.23获取手机验证码接口===
+
+===2.24中国车友会管理条例页面===
+
+===2.25车友会签到接口===
+
+===2.26编辑推荐论坛接口===
+
+===2.27论坛新帖数与新帖标题接口===
+
+===2.28论坛相关车友会接口===
+
+===2.29同城车友会列表接口===
+
+===2.30车友会排行榜接口===
+
+
+
+