APP接口开发规范文档-V1.0
百度知道开放平台openAPI接口规范文档 V1.0
百度知道开放平台OPEN API接口规范文档V 1.0系统名称百度知道开放平台OPEN API服务接口项目负责人作者陈霖文档提交日期2010-11-04百度在线网络技术（北京）有限公司(版权所有,翻版必究)修改记录No 修改后版本号修改内容简介修改日期修改人1 1.0 百度知道OPEN API服务接口2010-11-04 陈霖目录1背景 (6)2规范适用对象说明 (6)3名词解释 (6)4请求数据包格式规范 (6)4.1URL (6)4.2参数 (7)4.2.1系统级参数 (7)4.2.2业务级参数的通用约定 (7)4.2.3参数签名算法 (7)5响应数据包格式规范 (8)5.1XML输出格式 (8)5.2json输出格式 (9)5.3错误响应输出格式 (9)6错误码定义 (10)7API接口细则 (10)7.1baidu.zhidao.getCatalogInfo (10)7.1.1功能 (10)7.1.2参数 (11)7.1.3返回值 (11)7.2baidu.zhidao.getQuestionList (11)7.2.1功能 (11)7.2.2参数 (11)7.2.3返回值 (12)7.3baidu.zhidao.getQuestionSearch (12)7.3.1功能 (12)7.3.2参数 (12)7.3.3返回值 (13)7.4baidu.zhidao.getQuestionInfo (13)7.4.1功能 (13)7.4.2参数 (13)7.4.3返回值 (14)7.5baidu.zhidao.getQuestionAnswer (14)7.5.1功能 (14)7.5.2参数 (14)7.5.3返回值 (15)7.6baidu.zhidao.getUserInfo (15)7.6.1功能 (15)7.6.2参数 (15)7.6.3返回值 (15)7.7baidu.zhidao.getUserQuestionList (16)7.7.1功能 (16)7.7.2参数 (16)7.7.3返回值 (17)7.8baidu.zhidao.getUserAnswerList (17)7.8.1功能 (17)7.8.2参数 (17)7.8.3返回值 (18)7.9baidu.zhidao.getRecommend (18)7.9.1功能 (18)7.9.2参数 (18)7.9.3返回值 (19)7.10baidu.zhidao.getUserScoreRank (19)7.10.1功能 (19)7.10.2参数 (19)7.10.3返回值 (20)7.11baidu.zhidao.changeUserWealth (20)7.11.1功能 (20)7.11.2参数 (20)7.11.3返回值 (21)7.12baidu.zhidao.setBestAnswer (21)7.12.1功能 (21)7.12.2参数 (21)7.12.3返回值 (21)7.13baidu.zhidao.question (21)7.13.1功能 (21)7.13.2参数 (22)7.13.3返回值 (22)7.14baidu.zhidao.answer (22)7.14.1功能 (22)7.14.2参数 (22)7.14.3返回值 (23)8第三方提供API接口细则 (23)8.1回答反馈接口 (23)8.2动作提醒接口 (25)9附件及参考资料 (26)1背景本文旨在为第三方合作站点应用访问知道频道开放服务提供统一的HTTP接口调用与交互规范。
聚合云数据开放平台API接口文档 V1.0
类型 int string int string int
说明 返回码 返回说明 返回结果集 分类ID 分类名称 父类ID，0则为一级分类
返回码
名称 101 200
说明 appKey错误 成功的返回
备注
2ML http请求：POST/GET
40
7.2、暂停基金
40
7.2.1、暂停申购的基金
40
7.2.2、暂停赎回的基金
41
7.3、重仓股基金
41
7.3.1、重仓股基金
41
7.4、基金财务数据
42
7.4.1、主要财务指标
42
7.4.2、基金规模
43
7.4.3、资产配置
43
1、基站数据
1.1、移动联通基站
1.1.1、查询基站数据 基本信息
是否必须 是 是 否
key
string
是
说明 小区号 基站号 传递的LAC/CELL进制类型 ,十进制：10 十六进制：16 默认：10 APPKEY
返回参数
名称 resultcode reason data LAC CELL LNG LAT O_LNG
O_LAT
PRECISION
ADDRESS
类型 int string string string string string string
请求参数
名称 key fid
dtype
类型 string string
string
是否必须 是 否
否
说明 应用APPKEY(应用详细页 查询) 分类父ID，默认空，即全 部分类，否则返回指定分类 下的子类 返回数据的格式,xml或json ，默认json
API接口规范V1.0——制定好规范，才好合作开发
API接⼝规范V1.0——制定好规范，才好合作开发返回码规范：统⼀六位 000000 表⽰成功！参数相关返回码预留100000-199999；系统相关返回码预留200000-299999；数据中⼼310000-319999后续项⽬以此类推，后续根据业务扩展情况新增操作码需要提前备案！module = 系统码 optCode = 操作码 optDesc = 操作描述 resultCode = 结果码 resultDesc = 结果描述 bizCode = 业务码 data = 返回数据业务码 = 系统码- + 操作码- + 结果码业务码内容与之前定义的保持⼀致，实例：TaoBao- + Order_ADD- + 330002返回结果⽰例如下所⽰：异常返回：{"optCode": "STORE_ADDMSG","optDesc": "库管中⼼新增消息","resultCode": "330002","resultDesc": "库管中⼼新增消息失败，添加消息到搜索引擎库异常","data": "","module": "HME","bizCode": "TaoBao-Order_ADD-330002","success": false}正常返回：{"optCode": "STORE_ADDMSG","optDesc": "库管中⼼新增消息","resultCode": "000000","resultDesc": "操作成功","data": "","module": "HME","success": true,"bizCode": "Tao-Order_ADD-000000"}API⽂档规范：接⼝名称：products.search接⼝描述：中医药产品接⼝调⽤查询请求参数：响应参数：JSON返回⽰例：{"optCode": "STORE_ADDMSG","optDesc": "数据中⼼新增消息","resultCode": "000000","resultDesc": "操作成功","data": "[{"keywords": null,"tymc": "阿莫西林","tyjx": "颗粒剂","projectId": "44AFC2328D63A53EE05012AC241E3E1B", }]","module": "HME","success": true,"bizCode": "HME-STORE_ADDMSG-000000"}服务码参照：结果码参照：。
软件开发规范标准整体规范标准
软件开发规范标准整体规范标准XXXn: V1.0Date: 2010-06-22Prepared by: [Name of preparer]Table of Contents1.n1.1 Purpose1.2 Scope1.3 ns。
Acronyms。
and ns1.4 XXX1.5 Overview2.The Overall n2.1 are Development Organizing2.2 Project Base Process2.3 CMM Base Process2.3.1 SCM (are n Management)2.3.2 SPP (are Project Planning)2.3.3 SPTO (are Project Tracking and Oversight) 2.3.4 PR (Peer Reviews)2.3.5 SQA (are Quality Assurance)2.4 SDLC (are Development Life Cycle) n2.5 Development Process2.5.1 Development Phase2.5.2 Phase Product2.6 Role Duty2.7 Constraints3.Specific Requirements3.1 n3.1.1 SCM n Library3.1.2 Test Environment3.2 Development Control Process3.2.1 Project n and Planning Phase3.2.2 Requirements Analysis。
Design。
and Coding Phase3.2.3 Testing Phase3.2.4 n Release and Final Testing3.2.5 Post-Release Issue XXX3.3 TSP (Team are Process)3.3.1 XXX3.3.2 n Issues3.3.3 Code ReviewnThe purpose of this document is to XXX process。
接口设计规范V1.0---参考
接口设计规范V1.0---参考服务端与手机平台接口协议BespRout2014年11月目录1.概述 (3)2.涉及接口 (3)3.接口总体要求 (3)3.1.系统间接口的原则33.2.处理流程33.3.接口实现方式44.XXX服务端接口 (4)4.1.XX模块-根据XX下载相关的配置文件44.2.XX模块-生成指定XX的文件配置54.3.APP启动-初使化参数65.附件 (7)5.1.备注说明71. 概述本文档提供接口给手机端使用，为手机端提供业务平台数据2. 涉及接口本文档涉及的外围系统接口包括：无3. 接口总体要求3.1.系统间接口的原则接口设计遵循如下原则：⏹安全可靠性原则：系统应提供良好的安全性和可靠性策略，支持多种安全而可靠的技术手段，制定严格的安全可靠的管理措施；⏹开放性原则：提供开放式标准接口，提供与其它系统的互联互通；⏹灵活性原则：提供灵活的接口设计，便于接口的变动。
⏹可扩展性原则：支持新业务的扩展以及接口容量与接口性能的提高；⏹可管理性原则：提供良好的管理机制，保证在运行过程中提供给管理员方便的管理方式以处理各种情况；⏹统一性原则：应当保证系统的接口方式、接口形式、使用的协议等标准、统一。
3.2.处理流程接口处理流程4. XXX服务端接口测试地址前缀:http://192.168.3.208:8088/xxx/xxx 4.1.XX模块-根据XX下载相关的配置文件接口名称下载相关的配置文件接口描述根据厂商ID下载相关的配置文件测试地址前缀+/file/download/{storeId}?token=token参数详见配置请求方式GET正式地址待定参数请求体参数参数含义类型长度必填说明patform 平台String 20 必填值为iphone或者android响应体无4.2.XX模块-生成指定XX的文件配置接口名称生成指定商家的文件配置接口描述根据厂商ID，生成指定商家的文件配置测试地址前缀+/file/generate/{storeId}?token=token参数详见配置请求方式GET正式地址待定参数请求体无响应体参数参数含义数据类型说明respCode 标识是否操作成功String 0成功1失败respDesc 当标识respCode为1时候显示错误信息String4.3.APP启动-初使化参数接口名称初使化参数接口接口描述初使化参数接口测试地址前缀+/brands/param/list?token=token参数详见配置请求方式GET正式地址待定请求参数无响应体参数参数含义数据类型说明respCode 标识是否操作成功String 0成功1失败respDesc 当标识respCode为1时候显示错误信息StringshareFacebookUrl fb分享的地址String shareFacebookKey String shareFacebookSecret String shareFacebookInfo fb分享的内容String shareTwitterUrl tw分享的地址String shareTwitterKey String shareTwitterSecret String shareTwitterInfo tw分享的内容String shareEmail String shareEmailTitle email分享的标题StringmaxNumOfFamilyM ember 最多允许加入的家庭成员的个数StringguidingTextOfHBC HBC引导文字String helpTextOfHBC HBC帮助文字StringpayType 支付类型String 1-Authorize.net,2-TrustCommerce,3-ProPay注：以上所有内容需先Base64解，再DES解才可得到定义的内容5. 附件5.1.备注说明token算法生成说明：加密方式：手机与服务端各持有密钥Key，密钥暂定为XXXX。
(完整word版)用户端接口文档
用户端接口文档 -詹亚磊 2017/01/05 版本记录版本记录日期提交人备注V1.02017-01-05詹亚磊APP（魅客用户端）接口文档登录模块1、用户登录接口接口说明接口描述用户登录接口访问地址/user/free/login.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注用户第一次登录则进行注册，返回用户信息请求参数说明请求参数名必填类型请求参数说明cid true String 个推 ciduserAccount true string 登录信息（手机号或微信账号）type true int 登录类型（是手机号登录还是第三方微信登录1 ：phone 登录，2 ：wechat 登录）nickName false string 微信注册（或登录）时获取的微信昵称photo false string 微信注册（或登录）时获取的微信头像返回结果说明返回参数参数类型返回参数说明单个对象数据code int返回码msg string 返回信息data MmUser Model 模型返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（登录信息有误！）2、用户免登录接口接口说明接口描述用户免登录接口访问地址/user/free/autoLogin.do请求方式GET/POST请求格式JSON返回格式JSON开发人陈天兰备注用户免登录请求参数说明请求参数名必填类型请求参数说明userId true int 用户 idtoken true string 用户 token(token 在 json 请求数据中传递 )返回结果说明返回参数参数类型返回参数说明单个对象数据code int 返回码msg string 返回信息data MmUser Model 模型返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（免登录信息有误！）3、用户退出接口接口说明接口描述用户退出接口访问地址/user/logout.do请求方式GET/POST请求格式JSON返回格式JSON开发人刘辉备注用户退出登录，清空token请求参数说明请求参数名必填类型请求参数说明userId true int 当前用户 IDtoken true string 用户携带的 token返回结果说明返回参数参数类型返回参数说明单个对象数据code int 返回码msg string 返回信息data int更新影响条数（row = 1退出成功，row<1失败）返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（退出登录有误！）首页模块4、首页根据等级展示接口接口说明接口描述首页等级排序接口访问地址/user/free/gradeList.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注（显示所有通过审核且在服务状态的妹子）等级降序请求参数说明请求参数名必填类型请求参数说明pageNumb true int 当前页码（从 1 开始，第几页）lat true string 用户当前维度lag true string 用户当前经度返回结果说明返回参数参数类型返回参数说明Map对象数据code int返回码msg string返回信息babyList List<UserHomeRModel 模型esponse>bannerList List<SysBanner> Model 模型返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（没有查询到妹子信息）5、首页根据距离展示接口接口说明接口描述首页距离排序接口访问地址/user/free/distanceList.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注（显示所有通过审核且在服务状态的妹子）与用户距离降序请求参数说明请求参数名必填类型请求参数说明pageNumb true int 当前页码（从 1 开始，第几页）lat true string 用户当前维度lag true string 用户当前经度返回结果说明返回参数参数类型返回参数说明Map对象数据code int 返回码msg string 返回信息babyList List<UserHomeRModel 模型esponse>bannerList List<SysBanner> Model 模型返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（没有查询到妹子信息）6、首页根据注册时间最新展示接口接口说明接口描述首页最新列表接口访问地址/user/free/newList.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注（显示所有通过审核且在服务状态的妹子）审核时间降序请求参数说明请求参数名必填类型请求参数说明pageNumb true int 当前页码（从 1 开始，第几页）lat true string 用户当前维度lag true string 用户当前经度返回结果说明返回参数参数类型返回参数说明Map 对象数据code int 返回码msg string 返回信息babyList List<UserHomeRModel 模型esponse>bannerList List<SysBanner> Model 模型返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（没有查询到妹子信息）7、首页默认展示接口接口说明接口描述默认主页显示（妹子信息）访问地址/user/free/gradeList.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明pageNumb true int 当前页码（从 1 开始，第几页）lat true string 用户当前维度lag true string用户当前经度返回结果说明返回参数参数类型返回参数说明Map 对象数据code int 返回码msg string 返回信息babyList List<UserHomeRModel 模型esponse>bannerList List<SysBanner> Model 模型返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（没有查询到妹子信息）8、首页 -筛选查询接口接口说明接口描述首页筛选查询（根据年纪、身高、体重、金额条件查询）访问地址/user/free/filtrateBaby.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注（显示所有通过审核且在服务状态的妹子）按服务价格（等级）降序、和用户距离升序排列请求参数说明请求参数名必填类型请求参数说明pageNumb true int 当前页码（从 1 开始）lat true string 用户当前维度lag true string 用户当前经度maxAge true int 年龄上限minAge true int 年龄下限maxHeight true int 身高上限minHeight true int 身高下限maxWeight true int 体重上限minWeight true int 体重下限maxGradePrice true double 服务价格上限minGradePrice true double 服务价格下限测试数据 -- 请求参数：json={"pageNumb":"1","lat":"30.19","lag":"120.21","maxAge":"24","minAge":"13","maxHeight":"17 0","minHeight":"150","maxWeight":"50", "minWeight":"40","maxGradePrice":"1500","minGradePrice":"600"}返回结果说明返回参数参数类型返回参数说明Map 对象数据code int 返回码msg string 返回信息babyList List<UserHomeRModel 模型esponse>bannerList List<SysBanner> Model 模型返回码说明返回码（ reponse_code）说明200请求成功400请求失败（没有查询到妹子信息）9、显示妹子详细信息接口接口说明接口描述显示妹子详细信息访问地址/user/free/babyDetail.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注显示妹子详细信息（包括评价分数及当前用户对妹子的关注状态）请求参数说明请求参数名必填类型请求参数说明userId true int 当前用户 Id babyId true int 所选妹子 Id返回结果说明返回参数参数类型返回参数说明Map 对象数据code int 返回码msg string 返回信息baby MsBaby 所有妹子信息（ Model 对象）rateAvg double 妹子的评价平均分isAttention int 当前用户对该妹子的关注状态返回码说明返回码（ reponse_code）说明200 请求成功400 请求失败（没有查询到妹子详细信息）10、关注妹子接口接口说明接口描述用户关注妹子（已关注则取消，未关注则加关注）访问地址/user/attention.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注已关注则取消关注，未关注则加关注请求参数说明请求参数名必填类型请求参数说明userId true int 用户 ID babyId true int 所选妹子 IDisAttention true int 用户对所选妹子的关注状态（是否关注，显示妹子详情时已返回前端）token true string 用户登录成功返回的 token返回结果说明返回参数参数类型返回参数说明单个对象数据code int 返回码msg string 返回信息data int 用户对所选妹子的关注状态（isAttention ）返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（各种消息语）11、约会接口（点击约她）接口说明接口描述填写订单访问地址/user/invite.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注填写订单页面需要显示的妹子信息请求参数说明请求参数名必填类型请求参数说明babyId true int 所选妹子 IDtoken true string 用户登录成功返回的 token返回结果说明返回参数参数类型返回参数说明单个对象数据code int 返回码msg string 返回信息data MkOrderDetail Model 模型返回码说明返回码（ reponse_code）说明200 请求成功400 请求失败（请求失败，没有获取到妹子信息）排行榜模块12、人气排行榜接口接口说明接口描述显示妹子人气排行榜访问地址/user/free/popularList.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注按妹子已约单数降序排序请求参数说明请求参数名必填类型请求参数说明pageNumb true int当前页数（第几页，从 1 开始）返回结果说明返回参数参数类型返回参数说明List 对象数据code int 返回码msg string 返回信息data List<UserHomeRModel 模型esponse>返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（没有查询到人气榜单信息）13、信誉排行榜接口接口说明接口描述信誉排行榜访问地址/user/free/creditList.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注按妹子评价分降序排序请求参数说明请求参数名必填类型请求参数说明pageNumb True int当前页数（第几页，从 1 开始）返回结果说明返回参数参数类型返回参数说明List 对象数据code int 返回码msg string 返回信息data List<UserHomeRModel 模型esponse >返回码说明返回码（ reponse_code）说明200 请求成功400 请求失败（没有查询到信誉榜信息）用户端订单模块14、获取支付宝相关的KEY配置接口接口说明接口描述返回阿里支付相关的key 配置访问地址/alipay/keys.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明token true string token返回结果说明返回参数参数类型返回参数说明Map 对象数据code int 返回码msg string 返回信息alipayPartner stringalipayPrivateKey string 私钥alipayPublicKey string 公钥alipayOrderNotifyUrl string 回调地址alipayRechargeNotifstringyUrl返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（请求失败，没有获取到妹子信息）15、妹子是否有订单状态检查接口接口说明接口描述当前所选妹子是否已被抢走访问地址/userOrder/haveOrder.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注妹子当前是否在订单状态请求参数说明请求参数名必填类型请求参数说明babyIdList true List<Integer> 所选所有妹子的 IDtoken true string 用户登录成功返回的 token json={"babyIdList":[106,107,108,109]}返回结果说明返回参数参数类型返回参数说明Map 对象数据code int 返回码msg string 返回信息haveOrder boolean 是否有被抢单的妹子（ true- 有妹子已被抢走）cancleBabyList List<BabyHaveO被抢单的妹子的信息rderResponse>返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（请求失败，没有获取到妹子信息）16、支付检查接口（支付之前调用，更改妹子为有订单状态）接口说明接口描述支付之前调用，更改妹子为有订单状态访问地址/userOrder/payCheck.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注妹子当前是否在订单状态请求参数说明请求参数名必填类型请求参数说明babyIdList true List<Integer>所选所有妹子的IDtoken true string用户登录成功返回的tokenjson={"babyIdList":[106,107,108,109]}返回结果说明返回参数参数类型返回参数说明Map 对象数据code int 返回码msg string 返回信息cancleBabyList List<BabyHaveO如果所选妹子中有已被抢单的，则返回被抢单的妹子信息rderResponse>返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败17、用户支付失败，更新妹子订单状态接口接口说明接口描述用户支付失败，更新所选妹子的订单状态为无订单访问地址/userOrder/payFail.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明babyIdList true List<Integer>所选妹子ID列表token true string用户登录成功返回的token json={"babyIdList":[106,107,108,109]}返回结果说明返回参数参数类型返回参数说明单个对象数据code int 返回码msg string 返回信息data string “”返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（请求失败，没有获取到妹子信息）18、支付宝请客（下单）接口接口说明接口描述请客下单访问地址/alipay/free/orderNotify.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明userId true int用户IDuserCid true string用户CIDuserName true string userPhone true string userAddress true string meetAddress true string meetTime true date payMoney true bigDecimal payType true int tradeAccount true string orderNo true stringorderDetailListList<MkOrderDetailtrue>用户昵称用户手机号用户地址约会地址约会时间总支付金额支付方式收款账户订单号每条子订单的详情MkOrderDetail —--- 必填字段如下：babyName--string—妹子昵称babyPhoto—string--妹子头像gradeImg--string—等级图片babyPhone--string—妹子手机号scale--string—妹子尺度字符串payMoney—bigDecimal--该妹子支付金额babyCid--string—妹子cid返回结果说明返回参数参数类型返回参数说明List 对象数据code int 返回码msg string 返回信息data OrderPrederResponse Model 模型返回码说明返回码（ reponse_code）说明200请求成功400请求失败（没有查询到人气榜单信息）19、魅客钱包支付请客（下单）接口接口说明接口描述请客下单访问地址/alipay/walletOrder.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注请求参数说明请求参数名必填类型userId true intuserCid true stringuserName true stringuserPhone true stringuserAddress true stringmeetAddress true stringmeetTime true datepayMoney true bigDecimalpayType true inttradeAccount true stringorderNo true stringorderDetailList true List<MkOrderDetail>请求参数说明用户 ID用户 CID用户昵称用户手机号用户地址约会地址约会时间总支付金额支付方式收款账户订单号每条子订单的详情MkOrderDetail —--- 必填字段如下：babyName--string—妹子昵称babyPhoto—string--妹子头像gradeImg--string—等级图片babyPhone--string—妹子手机号scale--string—妹子尺度字符串payMoney—bigDecimal--该妹子支付金额babyCid--string—妹子cid返回结果说明返回参数参数类型返回参数说明List 对象数据code int 返回码msg string 返回信息data OrderPrederResponse Model 模型返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（没有查询到人气榜单信息）20、分享 -请客发送 H5 页面接口接口说明接口描述用户支付失败，更新所选妹子的订单状态为无订单访问地址/userOrder/payFail.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明babyId true int 所选妹子 IDtoken true string 用户登录成功返回的 token返回结果说明返回参数参数类型返回参数说明单个对象数据code int 返回码msg string 返回信息data boolean true- 当前妹子已被抢走，有订单false- 当前妹子不在订单状态返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（请求失败，没有获取到妹子信息）21、H5 约会接口接口说明接口描述H5 选妹子访问地址/userOrder/free/htmlInvite.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明babyId true int 所选妹子 IDuserCid true string 邀请人的 Cid返回结果说明返回参数参数类型返回参数说明单个对象数据code int 返回码msg string 返回信息data MkOrderDetail Model 模型返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（请求失败，没有获取到妹子信息）22、评价接口接口说明接口描述请客下单访问地址/userOrder/rate.do请求方式GET/POST请求格式JSON返回格式JSON开发人陈明钦json={"rateDetailList":[{"orderId":"900","userId":"1","userName":"username","userPhoto": 备注"1.jpg","content":"content","score":"10","babyName":babyName","babyId":"62","babyPhoto":"babyPhoto.jpg","babyPhone":"110","scale":"可爱 "}]}请求参数说明请求参数名必填类型请求参数说明orderId true int 订单 IDuserId true string 用户 IDuserName true string 用户昵称userPhoto true string 用户头像content false string 评价内容score true double 评价分数babyName true date 宝贝名称babyId true bigDecimal 宝贝 IDbabyPhoto true int 宝贝头像babyPhone true string 宝贝手机scale false String 宝贝尺度字符窜数组返回结果说明返回参数参数类型返回参数说明单个对象数据code int 返回码msg string 返回信息data row int 类型返回码说明返回码（ reponse_code）说明200请求成功400请求失败（评价失败）23、约会 -用户当前订单详情接口接口说明接口描述用户当前订单详情访问地址/userOrder/currentOrderDetail.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注显示用户正在进行中的订单详情请求参数说明请求参数名必填类型请求参数说明userId true int 当前用户 IDtoken true string 用户登录成功返回的 token返回结果说明返回参数参数类型返回参数说明Map 对象数据code int 返回码msg string 返回信息currentOrder CurrentOrderResModel 模型ponsehaveOrder int 用户当前是否有订单返回码说明返回码（ reponse_code）说明200请求成功400请求失败（没有查询到订单信息）妹子端订单模块24、约会 -妹子当前订单详情接口接口说明接口描述妹子当前订单详情访问地址/babyOrder/currentOrderDetail.do 请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注显示妹子当前订单详情和评价信息请求参数说明请求参数名必填类型babyId true intorderId true intorderDetailId true inttoken true string返回结果说明返回参数参数类型返回参数说明Map 对象数据code int 返回码msg string 返回信息请求参数说明当前妹子 ID当前大订单 ID当前订单详情 Id （小订单）用户登录成功返回的tokencurrentOrder MkOrder Model 模型 ( 订单详情 ) userOrderRate MkOrderRate Model 模型（评价详情）返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（没有查询到订单信息）25、妹子已到达接口接口说明接口描述妹子已到达约会地点，给用户推送消息访问地址/babyOrder/reached.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明orderId true int 当前大订单 ID orderDetailId true int 当前订单详情 ID （小订单）userId true int 用户 IDlate true int 妹子迟到的分钟数payMoney true bigDecimal 支付金钱userCid true string 用户 cidtoken true string 用户登录成功返回的 token返回结果说明返回参数参数类型返回参数说明Map对象数据code int 返回码msg string 返回信息orderStatus int 当前订单状态fineMoney bigDecimal 罚金钱返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（请求失败，没有获取到妹子信息）26、妹子已完成接口接口说明接口描述妹子点击完成订单访问地址/babyOrder/finish.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明orderId true int 当前大订单 ID orderDetailId true int 当前订单详情 ID （小订单）userId true int 用户 IDbabyId true int 妹子 IDpayMoney true bigDecimal支付金钱fineMoney true bigDecimal 罚金钱userCid true string 用户 cidtoken true string 用户登录成功返回的 token返回结果说明返回参数参数类型返回参数说明单个对象数据code int 返回码msg string 返回信息data int 订单状态返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（请求失败，没有获取到妹子信息）“我的”模块27、我的主页接口接口说明接口描述我的主页显示数据（历史订单数和我关注的人数）访问地址/user/myHomePage.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注显示历史订单数和我关注的人数（用户头像和昵称在登录时已返回）请求参数说明请求参数名必填类型请求参数说明userId true int 用户 IDtoken true string 用户登录成功返回的 token返回结果说明返回参数参数类型返回参数说明Map 对象数据code int 返回码msg string 返回信息orderCounter int 历史订单数attentionCounter int 我的关注人数money bigDecimal 最新的钱包数据返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（没有查询到订单数和关注数信息）28、支付宝钱包充值接口接口说明接口描述钱包充值访问地址/alipay/free/rechargeNotify.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注显示历史订单数和我关注的人数（用户头像和昵称在登录时已返回）请求参数说明请求参数名必填类型请求参数说明userId true int 用户 IDmoney true bigDecimal 充值的钱rewardMoney true bigDecimal 优惠的钱type true int 充值类型token true string 用户登录成功返回的 token返回结果说明返回参数参数类型返回参数说明单个对象数据code int 返回码msg string 返回信息data int row返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（没有查询到订单数和关注数信息）29、充值记录接口接口说明接口描述用户点击充值记录按钮访问地址/user/ rechargeHistory.do请求方式GET/POST请求格式JSON返回格式JSON开发人陈天兰备注显示充值记录列表（分页，按照充值时间升序排列）请求参数说明请求参数名必填类型请求参数说明userId true int 用户 IDPageNumb true int 第几页（从 1 开始）token true string 用户登录成功返回的 token 返回结果说明返回参数参数类型返回参数说明List 对象数据code int 返回码msg string 返回信息List<UserRechardate geHistoryRespon Model 模型se>返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（暂无充值记录）30、历史订单接口接口说明接口描述用户点击我的中历史订单按钮访问地址/user/orderHistory.do请求方式GET/POST请求格式JSON返回格式JSON开发人陈天兰备注显示历史订单列表（分页，未排序）请求参数说明请求参数名必填类型请求参数说明userId true int 用户 IDpageNumb true int 第几页（从 1 开始）token true string 用户登录成功返回的 token返回结果说明返回参数参数类型返回参数说明List 对象数据code int 返回码msg string 返回信息data List<UserOrderHModel 模型istoryResponse>返回码说明返回码（ reponse_code ）说明200 请求成功400 请求失败（暂无历史订单信息）31、我关注的人接口接口说明接口描述所有我关注的人访问地址/user/myAttentions.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注我关注的人列表（分页，按妹子升级的失效时间降序排序）请求参数说明请求参数名必填类型请求参数说明userId true int 用户 IDpageNumb true int 第几页（从 1 开始）token true string 用户登录成功返回的 token返回结果说明返回参数参数类型返回参数说明List 对象数据code int 返回码msg string 返回信息data List<UserHomeRModel 模型esponse>返回码说明返回码（ reponse_code）说明200请求成功400请求失败（没有关注的信息）接口说明接口描述查看历史订单详情访问地址/user/orderHistoryDetail.do 请求方式GET/POST请求格式JSON返回格式JSON开发人柳静备注显示历史订单详情请求参数说明请求参数名必填类型orderId true int userIsrate true int token true string 请求参数说明所选订单 ID用户是否评价用户登录成功返回的token返回结果说明返回参数参数类型返回参数说明List 对象数据code int 返回码msg string 返回信息date List<UserOrderHistoryDModel 模型etailResponse>返回码说明返回码（ reponse_code）说明200请求成功400请求失败（没有订单详细信息）接口说明接口描述修改用户支付密码访问地址/user/updatePayPwd.do请求方式GET/POST请求格式JSON返回格式JSON开发人柳静备注修改支付密码（若无，创建）请求参数说明请求参数名必填类型userId true int payPassword true String token true string 请求参数说明用户 ID支付密码用户登录成功返回的token返回结果说明返回参数参数类型返回参数说明List 对象数据code int 返回码msg string 返回信息date row int返回码说明返回码（ reponse_code）说明200请求成功400请求失败（修改支付密码失败）验证码模块34、短信验证码接口接口说明接口描述短信验证码访问地址/sms/free/verifyCode.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明phone true string需要发送验证码的手机号返回结果说明返回参数参数类型返回参数说明Map 对象数据code int 返回码msg string 返回信息creatTime Date 验证码发送时间verifyCode string 验证码返回码说明返回码（ reponse_code）说明200请求成功400请求失败（发送验证码失败）35、语音验证码接口接口说明接口描述语音验证码（暂时不接）访问地址/sms/free/voiceCode.do请求方式GET/POST请求格式JSON返回格式JSON开发人詹亚磊备注请求参数说明请求参数名必填类型请求参数说明phone true String需要发送验证码的手机号返回结果说明返回参数参数类型返回参数说明Map 对象数据code int 返回码msg string 返回信息creatTime Date 验证码发送时间verifyCode string 验证码返回码说明返回码（ reponse_code）说明200请求成功400请求失败（发送验证码失败）。
app接口文档模板
XXX项目APP接口文档首页 (3)首页 (3)加载更多商品 (7)用户注册 (9)注册 (9)发送手机验证码 (11)用户中心 (12)登录 (12)登出 (14)原产品 (15)产品列表 (15)产品详情 (18)分类树 (22)备注： (23)注：传参一律用post方式，key=request, value为一串json格式字符串，格式如：request={"head": {"partner": "xxxxxxxxxxxxxxxxxxxxxxx","key": "xxxxxxxxx","mdkey": "xxxxxxxxxxx"},"para": {"user_name": "user_name","pwd": "123456"},"result": {"start": 0,"count": 10}}head：头信息，用于安全校验，参数固定为partner、key、mdkey 三项，mdkey随不同接口而变，partner和key为常量头部信息校验错误统一返回，错误码分三种：1：PARTNER有误{"head": {"code": "C0004","msg": "PARTNER验证失败！"}}2：KEY有误{"head": {"code": "C0005","msg": "KEY验证失败！"}}3：MD5加密错误{"head": {"code": "C0001","msg": "请求验证失败！"}}para：请求体，客户端请求所需要传入的参数，依据不同接口而定result：结果集，主要用于分页首页首页URL：输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(partner+key)},"result": {"start": 0, //从第0条数据开始，（首页此项参数只能为0）"count": 20 //总共返回20条数据，（即每页显示数量，由客户端自定）}}输入参数说明：错误码：参考头部信息校验统一错误码正确返回：{"head": {"code": "10000","msg": "数据获取成功"},"para": {"banner": [{"ad_id": "2","ad_name": "首页轮转2","pic": "/data/files/mall/ad/1434512150.jpg","link": "/index.php?app=search&act=products&cid=1312","image_size": {"width": 1200,"height": 475}},{"ad_id": "3","ad_name": "首页轮转3","pic": "/data/files/mall/ad/1434523823.png","link": "/joinus/","image_size": {"width": 1200,"height": 475}}……],"cate": [{"cate_id": "1216","cate_name": "女装","cate_ename": "WOMEN","cate_banner": "/data/files/mall/category/2015/06/201506100640272205.jpg","image_size": {"width": 460,"height": 300}},{"cate_id": "1217","cate_name": "男装","cate_ename": "MEN","cate_banner": "/data/files/mall/category/2015/06/201506081359262711.jpg","image_size": {"width": 460,"height": 300}}……],"pic": [{"pic_id": "311","pic_name": "小女孩·柠檬汽水","price": "25.00","pic_url": "/data/files/store_238/pic/2015/06/201506160937045578.jpg", "collects": "1","views": "0","sales": "0","image_size": {"width": 2063,"height": 2063},"love": true //是否关注，true已关注，false未关注},{"pic_id": "314","pic_name": "小女孩·漫漫花事","price": "35.00","pic_url": "/data/files/store_238/pic/2015/06/201506161014059499.jpg", "collects": "1","views": "0","sales": "0","image_size": {"width": 2244,"height": 3488},"love": false}……],"products": [{"product_id": "176","product_name": "三脚猫原创手工皮革染色单肩包手工定制","price": "400.00","image_url": "/data/files/store_90/openshop/product_pic.JPG","collects": "1","views": "0","sales": "0","image_size": {"width": 3000,"height": 3000},"love": true //是否关注，true已关注，false未关注},{"product_id": "2066","product_name": "H.Cstudio 黑白拼色走秀款真丝缎面","price": "499.00","image_url": "/data/files/store_79/product/2015/06/201506150339342394.jpg","collects": "0","views": "0","sales": "0","image_size": {"width": 515,"height": 774},"love": false}……]},"result": {"start": 1,"count": 20}}正确返回码说明：加载更多商品URL：/index.php/index/load_more输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(partner+key)},"result": {"start": 21, //从第21条数据开始"count": 20 //总共返回20条数据，（即每页显示数量）}}返回码描述：错误码：参考头部信息校验统一错误码正确返回：{"head": {"code": "10000","msg": "数据获取成功"},"para": {"products": [{"product_id": "176","product_name": "三脚猫原创手工皮革染色单肩包手工定制","price": "400.00","image_url": "/data/files/store_90/openshop/product_pic.JPG","collects": "1","views": "0","sales": "0","image_size": {"width": 3000,"height": 3000},"love": true //是否关注，true已关注，false未关注},{"product_id": "2066","product_name": "H.Cstudio 黑白拼色走秀款真丝缎面","price": "499.00","image_url": "/data/files/store_79/product/2015/06/201506150339342394.jpg","collects": "0","views": "0","sales": "0","image_size": {"width": 515,"height": 774},"love": false}……]},"result": {"start": 21,"count": 20}}正确返回码说明：用户注册注册URL：/index.php/register/reg输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(mobile+pwd+cpwd+sms_captcha+nick_name+partner+key) },"para": {"mobile": "注册手机号","pwd": "密码","cpwd": "确认密码","sms_captcha": "手机接收的验证码","nick_name": "昵称"}}输入参数说明：返回码描述：错误码：{"head": {"code": "E0003","msg": "注册验证失败"}}{"head": {"code": "E0001","msg": "用户名已存在！"}}{"head": {"code": "E0001","msg": "两次密码不一致"}}正确返回：{"head": {"code": "10000","msg": "恭喜，注册成功！"},"para": {"user_name": "user","phone_mob": "user","nick_name": "oheyou","status": 1,"user_id": 263}}正确返回码说明：发送手机验证码URL：/index.php/register/send_sms_captcha 输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(partner+key)},"para": {"mobile": "用户手机号"}}输入参数说明：返回码描述：错误码：{"head": {"code": "E0005","msg": "手机号码不正确"}}正确返回：{"head": {"code": "10000","msg": "短信发送成功"}}真确返回码说明：用户中心登录URL：/index.php/user/login输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(user_name+pwd+partner+key)},"para": {"user_name": "用户名","pwd": "密码"}}返回码描述错误码：{"head": {"code": "E0003","msg": "用户名或密码错误！"}}正确返回：{"head": {"code": "10000","msg": "登录成功"},"para": {"user_id": "76","user_name": "user","nick_name": "oheyou","gender": "0","im_qq": "0","email":"****************","points": "0","portrait": "/data/files/usr/76/2015/05/201505140448321718.jpg","logins": "0","last_login": "1435226105","follow": "4", //关注数量"fans": "1", //粉丝数量"loves": "12", //喜欢数量（产品，图片，商品）"collects": "0" //店铺收藏数量}}正确返回码说明：登出URL：/index.php/user/login_out 输入参数：request={"head": {"key": "ldingadmin","mdkey": md5(partner+key)}}输入参数说明：返回码描述错误码：无正确返回：{"head": {"code": "10000","msg": "登出成功！"}}正确返回码说明：原产品产品列表URL：/index.php/product 输入参数：request={"head": {"key": "ldingadmin","mdkey": md5(cid+order+partner+key) },"para": {"cid": "分类id","order": "排序",},"result": {"start": "0","count": "20",}}输入参数说明：错误码：参考头部信息校验统一错误码正确返回：{"head": {"code": "10000","msg": "数据获取成功"},"para": [{"product_id": "2073","product_name": "HC STUDIO 黑色羊毛西装裤","add_time": "1434346771","price": "219.00","min_price": "219.00","max_price": "219.00","store_id": "79","store_name": "HC 定制工作室","image_url": "/data/files/store_79/product/2015/06/201506230847457013.png","view": "0", //浏览量"collects": "2", //收藏量"carts": "0", //加入购物车量"orders": "0", //下单量"sales": "0", //销售量"comments": "0", //评论量"love": false //是否喜欢},{"product_id": "2071","product_name": "HC STUDIO 优雅锦缎提花褶半身裙","add_time": "1434346569","price": "249.00","min_price": "249.00","max_price": "249.00","store_id": "79","store_name": "HC 定制工作室","image_url": "/data/files/store_79/product/2015/06/201506190721567528.jpg","view": "0","collects": "0","carts": "0","orders": "0","sales": "0","comments": "0","love": false},……],"result": {"start": 0,"count": 20}}产品详情URL：/index.php/product/detail 输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(product_id+partner+key)},"para": {"product_id": "产品id"},"result": { //用于评价和咨询"start": "0","count": "20",}}输入参数说明：错误码：参考头部信息校验统一错误码正确返回：{"head": {"code": "10000","msg": "数据获取成功"},"para": {"product_id": "134","product_name": "poly~(测试专用)","price": "0.01","default_image_id": "616", //商品主图id"image_url": "/data/files/store_76/openshop/product_pic.jpg", //商品主图地址"content": "啦啦啦啦啦啦", //商品详情"tags": [ //商品标签"连衣裙","雪纺","真丝","飘逸"],"brand_id": null, //商品品牌id"brand_name": null, //商品品牌名称"brand_logo": null,//商品品牌logo"store_id": "75", //店铺id"store_name": "awesome", //店铺名称"store_type": "1", //店铺类别1：个人2：公司"apply_type": "seller", //店铺申请类型seller：供应商designer：设计师"description": null, //店铺简介"store_collects": "0", //店铺收藏量"store_sales": "5", //店铺销售量"views": "0", //商品浏览量"carts": "7", //商品加入购物车量"collects": "2", //商品喜欢量"sales": "6", //商品销售量"comments": "0", //商品评论量"orders": "8", //商品下单量"product_loved": false, //是否喜欢过此商品（用户未登录一律返回false）"store_collected": false,//是否收藏过此店铺（用户未登录一律返回false）"spec_text": [ //商品规格描述{"spec_id": "80","spec_name": "颜色","is_color": "0","values": [{"spec_val_id": "23","sval_text": "白色","spec_val_text": "白色"},{"spec_val_id": "24","sval_text": "红色","spec_val_text": "红色"}]{"spec_id": "77","spec_name": "尺码","is_color": "0","values": [{"spec_val_id": "15","sval_text": "M","spec_val_text": "M"},{"spec_val_id": "16","sval_text": "L","spec_val_text": "L"}]}],"sku": { //商品sku";80:23;77:15;": {"sku_id": "541","price": "0.01","is_show": "1"},";80:23;77:16;": {"sku_id": "542","price": "0.01","is_show": "1"},";80:24;77:15;": {"sku_id": "543","price": "0.01","is_show": "1"},";80:24;77:16;": {"sku_id": "544","price": "0.01","is_show": "1"}},"images_datas": [ //商品其他部位图片地址{"image_url": "/data/files/store_75/product/2015/05/201505190926367050.jpg"{"image_url": "/data/files/store_75/product/2015/05/201505190927329810.jpg"}],"qa": [ //商品咨询数据{"reply_content": " hahahaha ","time_post": "1435200728","nick_name": "oheyou","portrait": "/data/files/usr/76/2015/05/201505140448321718.jpg"}],"comment": "" //商品评论数据（格式如咨询）},"result": {"start": 0,"count": 20}}正确返回码说明：分类树URL：/index.php/product/cate输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(partner+key)}}输入参数说明：返回码描述错误码：无正确返回：Json格式分类树正确返回码说明：备注：1000 操作成功。
软件开发规范整体规范
-……-虚线表示工作的汇报关系，如SQAE向SQA经理汇报。
2.2
基本流程说明：
项目启动：本阶段主要是进行可行性分析，定义项目，识别需求； 制定计划：本阶段主要是计划策划，估算工作量，制定具体的可执行的计划； 计划实施：本阶段主要是实施计划，完成计划中的各项任务，报告计划状态； 项目终止：计划执行完毕，总结项目；
5.2开发过程文档35
5.2.1软件配置管理35
5.2.2会议管理36
5.2.3计划跟踪36
5.2.4评审管理36
5.2.5质量管理36
5.2.6测试过程36
5.2.7问题解决过程36
5.2.8其他37
6Appendix附录37
6.1易于理解的代码37
6.2Log输出37
1
一个成熟稳定的组织或者团队，能够减少风险，经常地成功地达成目标。成功的含义是： 按时、预算内【即符合成本要求】、符合质量要求。换言之，成熟稳定的团队，能够避免 以下问题：
3.4.6Deployer发布人员33
4Tool Specification工具规范33
4.1通用工具33
4.2计划33
4.3需求分析34
4.4设计34
4.5编码34
4.6测试34
5Documents文档35
5.1项目管理文档35
5.1.1项目策划35
5.1.2项目追踪35
5.1.3质量保证35
5.1.4项目终止35
基本过程说明：
SCM:软件配置管理，所有活动的基础，一切制品必须放入配置库；
SPP:软件项目策划，估算工作量，制定详细计划【项目的制定计划阶段】；
SPTO:项目追踪，报告项目状态，评估并更新计划【项目的计划实施阶段】；PR：同行评审，进入基线的前提条件，降低风险，提高质量的有效手段；
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
{ APP接口规文档}手机客户端接口文档
版本历史
目录
一、概述 (1)
1.1 有关接口 (1)
1.1.1接口是纯数据的交互 (1)
1.2 接口的分类 (1)
1.2.1查询类接口 (1)
1.2.2 操作类接口 (1)
1.2.3上传下载类接口 (1)
1.2.4推送类接口 (1)
二、查询类接口格式规 (1)
2.1获取单条对象信息 (1)
2.1.1 请求格式 (1)
2.1.2参数说明 (2)
2.1.3正常返回结果 (2)
2.2获取列表对象信息 (3)
2.2.1 请求格式 (3)
2.2.2参数说明 (3)
2.2.3正常返回结果 (3)
三、操作类接口 (4)
3.1 新增操作 (4)
3.1.1接口说明 (4)
3.1.2参数说明 (4)
3.1.3正常返回结果 (4)
3.1.4错误返回列表 (5)
3.2 修改操作 (5)
3.2.1接口说明 (5)
3.2.2参数说明 (5)
3.2.3正常返回结果 (5)
3.2.4错误返回列表 (5)
3.3 删除操作 (6)
3.3.1接口说明 (6)
3.3.2参数说明 (6)
3.3.3正常返回结果 (6)
3.3.4错误返回列表 (6)
四、上传下载类 (7)
4.1 上传文件 (7)
4.1.1接口说明 (7)
4.1.2参数说明 (7)
4.1.3正常返回结果 (7)
4.1.4错误返回列表 (7)
4.2 下载文件 (7)
4.2.1接口说明 (7)
4.2.2参数说明 (8)
4.2.3正常返回结果 (8)
4.2.4错误返回列表 (8)
五、推送类接口 (8)
5.1 推送消息 (8)
5.1.1接口说明 (8)
5.1.2参数说明 (8)
5.1.3正常返回结果 (9)
5.1.4错误返回列表 (9)
六、通用返回格式 (9)
6.1 正确返回 (9)
6.1.1接口说明 (9)
6.1.2参数说明 (9)
6.1.3正常返回结果 (9)
6.1.4错误返回列表 (10)
6.2 错误返回 (10)
6.2.1接口说明 (10)
6.2.2参数说明 (10)
6.2.3正常返回结果 (10)
6.2.4错误返回列表 (10)
七、附录 (11)
7.1 通用错误返回列表 (11)
7.2 URL地址信息 (11)
7.2.1 主机地址 (11)
7.2.2 URL列表 (11)
7.3 安全机制 (11)
7.3.1 验证签名机制 (11)
7.4 其他 (12)
7.2.1 列表数据为空的返回 (12)
一、概述
1.1 有关接口
1.1.1接口是纯数据的交互
APP接口是移动设备和业务之间进行通信的途径。
实质就是以特定的规则通过接口直接操作数据库的增删改查。
1.2 接口的分类
1.2.1查询类接口
查询类接口是指客户端传递一些参数，服务端根据参数依据需求，前往数据库查询需要的结果返回数据的一类接口。
返回类型一般有两种。
第一种是返回一个对象，第二种是返回一个数组对象。
第一种比如登陆，客户端把用户名密码上传到接口，服务器返回用户的个人信息。
第二种比如获取客户，客户端把用户的身份信息上传到接口，服务器返回此身份下的所有客户数组集合。
1.2.2 操作类接口
操作类接口是指，客户端通过接口进行一些增删改的操作。
比如新增一个客户，修改客户信息，或者删除一个客户。
服务器一般返回执行的状态，有的需要返回执行结果的一些信息，比如新增客户后，返回客户的ID。
1.2.3上传下载类接口
上传下载类接口是涉及到文件传输的接口。
比如上传头像，需要上传图片到服务器，服务端根据需求响应保存并返回结果。
比如客户端需要显示用户头像，需要读取网络图片文件，在手机上进行显示。
1.2.4推送类接口
除了客户端主动去请求服务端，获取需要信息之外。
有时候，也存在服务端有消息需要通知客户端的情况，这时候就是服务端向客户端发送消息。
这类需求可以通过客户端短时间类循环请求解决，也可以通过第三方专业推送解决。
也可以通过自己使用socket或者xmpp 等协议进行开发。
二、查询类接口格式规
2.1获取单条对象信息
2.1.1 请求格式
2.1.2参数说明
2.1.3正常返回结果
详见：通用错误返回列表
2.2获取列表对象信息2.2.1 请求格式
2.2.2参数说明
2.2.3正常返回结果
详见：通用错误返回列表
三、操作类接口
3.1 新增操作
3.1.1接口说明
3.1.2参数说明
3.1.3正常返回结果
3.1.4错误返回列表
详见：通用错误返回列表3.2 修改操作
3.2.1接口说明
3.2.2参数说明
3.2.3正常返回结果
3.2.4错误返回列表
详见：通用错误返回列表
3.3 删除操作
3.3.1接口说明
3.3.2参数说明
3.3.3正常返回结果
3.3.4错误返回列表
详见：通用错误返回列表
四、上传下载类
4.1 上传文件
4.1.1接口说明
4.1.2参数说明
4.1.3正常返回结果
4.1.4错误返回列表
详见：通用错误返回列表4.2 下载文件
4.2.1接口说明
4.2.2参数说明
4.2.3正常返回结果
4.2.4错误返回列表
详见：通用错误返回列表
五、推送类接口
5.1 推送消息
5.1.1接口说明
5.1.2参数说明
5.1.3正常返回结果
5.1.4错误返回列表
详见：通用错误返回列表
六、通用返回格式
6.1 正确返回
6.1.1接口说明
6.1.2参数说明
6.1.3正常返回结果
6.1.4错误返回列表
详见：通用错误返回列表
6.2 错误返回
6.2.1接口说明
6.2.2参数说明
6.2.3正常返回结果
6.2.4错误返回列表
详见：通用错误返回列表
七、附录
7.1 通用错误返回列表
7.2 URL地址信息
7.2.1 主机地址
LocalHost正式地址：192.168.0.1/
LocalHost测试地址：192.168.0.1/ 7.2.2 URL列表
7.3 安全机制
7.3.1 验证签名机制
生成Token
7.4 其他
7.2.1 列表数据为空的返回
列表数据为空时显示"DataList": []。