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.1. 编写说明以及范围本文档说明主要描述云平台对外系统提供的应用接口以及WEB 页面,便于客户进行云系统的集成和对接。
更方便于系统开发人员对接口的使用。
1.2. 承载方式数据接口调用采用基于HTTP的GET/POST调用方式。
WEB接口采用直接访问页面的调用方式。
第二章接口说明2.1. 参数说明(系统级参数和应用级参数,系统级参数如下表,应用级参数根据具体接口不同):2.2. 结果内容说明2.3. 错误代码含义2.4. 注意事项a.接口的参数名称都要小写,参数值除了特定的都小写b.数据编码格式:UTF-8c.一些特殊的接口方法返回结果以Web页面呈现第三章接口访问安全控制说明3.1. 访问控制API接口访问必须经过公司授权后才可以使用,授权成功后会得到授权码(公钥和密钥,分别是:appkey,appsecret),在每次访问API接口时必须指定公钥。
否则访问就会被拒绝。
3.2. 接口请求时间有效性外部系统调用API接口时,每次都要传参数timestamp,API服务端允许客户端请求时间误差为6分钟。
3.3. 接口调用频率控制同一接口调用频率必须在1毫秒以上。
3.4. 数据安全控制调用API接口时需要对请求参数进行签名验证,服务器也会对该请求参数进行验证是否合法。
防止数据被传递过程当中发生数据篡改。
具体签名算法见下列。
3.5. 签名sign具体算法为:根据传入参数名称(签名sign除外)将所有请求参数按照首字母先后顺序排序,md5(密钥+除密钥外排好序的参数串+密钥)后转换为大写字母。
调用示例:外部系统获得的公钥和密钥分别为:appkey = abe10b89-8185-483a-b28f-894f7957f78dappsecret = 184CD4DF-C5D2-4F55-8539-ED45D4E91FBB(注意:调用时需将获取的公钥和密钥原样传入,不得改变大小写、不得去掉“-”)获取车辆最新位置信息接口的参数如下:method=GetVehcileInfoappkey= abe10b89-8185-483a-b28f-894f7957f78dtimestamp=2014-11-8 11:47:42format = jsonvehicle = 陕A0000sessionid = ""计算结果如下:md5('184CD4DF-C5D2-4F55-8539-ED45D4E91FBBappkeyabe10 b89-8185-483a-b28f-894f7957f78dformatjsonmethodGetVehcileInf osessionidtimestamp2014-11-8 11:47:42vehicle陕A0000184CD4DF-C5D2-4F55-8539-ED45D4E91FBB')计算结果为:F974B39EA75655663A4C1E552335864B备注:记得加密结果转换为大写字母格式后即为所需签名。
软件接口规定指南
软件接口规定指南1. 背景本文档旨在为软件接口的设计和使用提供一些指导原则和规定,以确保软件接口的一致性、可靠性和安全性。
2. 接口设计原则在设计软件接口时,应遵循以下原则:- 简单性:接口应该尽可能简单明了,避免过多的复杂性和不必要的功能。
- 一致性:接口的命名和用法应该保持一致,以便用户能够轻松理解和使用。
- 可扩展性:接口应该具备一定的可扩展性,以便在后续需求变化时能够方便地进行修改和升级。
- 可靠性:接口应该经过充分的测试和验证,确保其在各种使用场景下都能正常运行。
3. 接口安全性规定为确保软件接口的安全性,应遵循以下规定:- 身份验证:对于需要访问敏感数据或进行敏感操作的接口,应要求用户进行身份验证,以确保只有授权的用户可以使用。
- 权限控制:接口应该实现权限控制机制,以确保不同用户只能访问其具备权限的接口功能。
- 数据加密:对于传输敏感数据的接口,应使用合适的加密算法进行数据加密,以防止数据泄露。
- 防止攻击:接口应该具备一定的防护措施,如输入验证和防止常见的安全漏洞,以防止恶意攻击。
4. 接口文档规范为了提高接口的可理解性和使用性,接口文档应遵循以下规范:- 清晰明了:接口文档应该清晰明了地描述每个接口的功能、参数和返回值,以便用户能够快速理解和使用。
- 示例演示:接口文档中应提供示例代码和演示,以帮助用户更好地理解接口的使用方法。
- 更新及时:接口文档应该及时更新,以反映接口的最新变化和更新。
5. 接口版本管理为了有效地管理接口的变化和升级,应采取以下措施:- 版本控制:对接口进行版本控制,确保不同版本的接口能够兼容和平滑升级。
- 变更通知:及时通知用户接口的变更和升级,以便用户做出相应的调整和更新。
6. 接口测试要求为确保接口的质量和稳定性,应进行充分的接口测试,包括以下要求:- 功能测试:测试接口的功能是否符合需求和预期。
- 性能测试:测试接口的性能,包括响应时间、并发能力等。
通用接口实用标准化要求规范v1
接口标准规目录接口标准规 (1)第1章概述 (3)第2章基本要求 (4)2.1信息通讯安全 (4)2.1.1 安全评估 (4)2.1.2 访问控制 (4)2.1.3 防恶意代码 (4)2.1.4 加密 (5)2.2支持高并发 (6)2.3可监控 (6)2.3.1 日志全覆盖 (6)2.4系统资源的动态扩展 (6)2.5异常处理机制 (7)2.6业务扩展 (7)第3章接口通讯方式 (7)3.1同步请求/应答方式 (7)3.2异步请求/应答方式 (7)3.3会话方式 (7)3.4广播通知方式 (7)3.5事件订阅方式 (7)3.6文件传输 (8)3.7可靠消息传输 (8)第4章传输控制要求 (8)4.1负载均衡 (8)4.2伸缩性与动态配置管理 (8)4.3网络调度 (9)4.4充分理由 (9)4.5单一职责 (9)4.6高聚低耦合 (9)4.7状态及消息 (10)4.8控制数据量 (10)4.9禁止随意拓展参数 (10)第5章接口技术 (10)第6章接口规 (11)6.1域名规 (11)6.1.1 http接口 (11)6.1.2 webservice接口 (11)6.2 API路径规 (11)6.2.1 http接口 (11)6.2.2 webservice接口 (11)6.3版本控制规 (12)6.3.1 http接口 (12)6.3.2 webservice接口 (12)6.4 API命名规 (12)6.4.1 新增方法 (13)6.4.2 删除方法 (13)6.4.3 修改方法 (13)6.4.4 获取方法 (13)6.4.5 获取列表方法 (13)6.5请求参数规 (14)6.5.1 参数需要命名规则 (14)6.5.2 请求参数加密方法 (14)6.6列表请求特殊规 (15)6.7返回数据规 (15)第7章接口文档规 (16)第8章接口管理 (16)8.1对接口分类、编码排序。
(16)8.2在线文档。
APP接口开发规精选范文档V.0
APP 接口规范文档{ APP 接口规范文档 }手机客户端接口文档文件状态:文件表记:[ ] 稿本当前版本:[ √ ] 正式宣布作者:Stone[ ] 正在更正完成日期:版本历史版本 /状态稿本作者Stone参加者搬动小组起止日期备注目录一、归纳 (1)有关接口 (1)接口是纯数据的交互 (1)接口的分类 (1)盘问类接口 (1)操作类接口 (1)上传下载类接口 (1)推送类接口 (1)二、盘问类接口格式规范 (1)2.1 获取单条对象信息 (1)央求格式 (1)参数说明 (2)正常返回结果 (2)2.2 获取列表对象信息 (3)央求格式 (3)参数说明 (3)正常返回结果 (3)三、操作类接口 (4)新增操作 (4)接口说明 (4)参数说明 (4)正常返回结果 (4)错误返回列表 (5)更正操作 (5)接口说明 (5)参数说明 (5)正常返回结果 (5)错误返回列表 (5)删除操作 (6)接口说明 (6)参数说明 (6)正常返回结果 (6)错误返回列表 (6)四、上传下载类 (7)上传文件 (7)接口说明 (7)参数说明 (7)正常返回结果 (7)错误返回列表 (7)下载文件 (7)接口说明 (7)APP 接口规范文档参数说明 (8)正常返回结果 (8)错误返回列表 (8)五、推送类接口 (8)推送信息 (8)接口说明 (8)参数说明 (8)正常返回结果 (9)错误返回列表 (9)六、通用返回格式 (9)正确返回 (9)接口说明 (9)参数说明 (9)正常返回结果 (9)错误返回列表 (10)错误返回 (10)接口说明 (10)参数说明 (10)正常返回结果 (10)错误返回列表 (10)七、附录 (11)通用错误返回列表 (11)7.2 URL 地址信息 (11)主机地址 (11)7.2.2 URL 列表 (11)安全体系 (11)考据签字体系 (11)其他 (12)列表数据为空的返回 (12)APP 接口规范文档一、归纳1.1 有关接口1.1.1 接口是纯数据的交互APP 接口是搬动设备和业务之间进行通信的路子。
通用App接口定义文档规范
阅读之前(必读*):1.所有接口返回数据格式为{code:’0000’,msg:’’,data:{}}的形式其中code 是响应码msg 是响应消息默认正确响应无msg消息只有错误才有错误消息data 为数据段.Java段对应返回数据bean为如下形式。
2.响应码表对应codeString SUCCESS = "0000";String SUCCESS_MSG = "成功";String ERROR = "0001";String ERROR_MSG = "失败";String PARAM_ERROR = "0002";String PARAM_ERROR_MSG = "参数错误或者参数不完整";String NO_PERMISSION = "UP01";String NO_PERMISSION_MSG = "无接口访问权限";String UE01 = "UE01";String UE01_MSG = "未知接口异常";测试服务器调试路径115.159.28.17/ssm3登录逻辑附件如下:app登录流程.txt1.接口服务器验证接口{"msg": “成功”,"code": “0000”data:{token:’’role:’1’; //1 superadmin 2亲情号phoneNumber:’139080090’name:’王小二’sex:’’,//1 男2 女className:’’,birthday:’’,otherCards:[{imei:2313123name:小明}]}}1.1注销接口1.2修改密码接口需要返回的数据{"msg": “成功”,"code": “0000”}2.宝贝信息设置接口{"msg": “成功”,"code": “0000”}3.学生卡主动定位接口需要返回的数据:{"batteryValue": 100, //电量"data": {"locationType": 1, //定位类型GPS 0,北斗1,基站2."coord": {"latitude": 22.566235,"longitude": 113.90045}},"updateTime": 15452154,//更新时间"msg": “成功”,"code": “0000”}4.围栏列表查询接口{"count": 3,"data": [{“meter”:123123“name”:’学校’//围栏名称“gpsPointWeidu”:23.123123 // 中心纬度“gpsPointJingdu”:132.23213123 // 中心经度}],"code": 0000“msg”:”成功”}5.设置围栏接口数据接口定义备注1、调用结果以json格式返回2、接口地址: /card/setSafeCircles输入字段定义序号字段名称字段定义数据类型备注1 token token 字符串2safeCircles 围栏列表字符串围栏列表List<SafeCircle> JSON字符串SafeCircle{meter //半径name //围栏名称gpsPointWeidu // 中心纬度gpsPointJingdu // 中心经度}输出数据格式{"msg": “成功”,"code": “0000”}6.历史轨迹查询接口数据接口定义{"count": 2,"data": [{"time": 24,"coord": {"latitude": 22.576584,"longitude": 113.87609},‘dingweiType’:1//0北斗1GPS 2基站},{"time": 42,"coord": {"latitude": 22.575483,"longitude": 113.873566}‘dingweiType’:1}//...等等等],"updatetime ": 07,"code": ‘0000’‘msg’:’成功’}5.亲情号设置接口Qinqinghao{name:’妈妈’phoneNum:’2’}需要返回的数据:{"code": ‘0000’‘msg’:’成功’}6.获取宝贝信息{"data": {"childBirthday": 123151351,"childGrade ": "","childName": "","childSex": 1 //1 男2 女}code:’0000’msg:’成功’}获取亲情{count:2data:[{name:妈妈phoneNum:1390943233},{name:爸爸phoneNum:1390943233}]code:’0000’msg:’成功’}7.获取上课隐身接口{"count": 4,"data": [{"repeatCycleMode": "012","timeEnd": "19:00","timeStart": "8:00" ,“openState”:0 //表示是否启用字符串1表示启用,0表示不启用} //等等],"code": ‘0000’‘msg’:’成功’}/**TimeEnd StringTimeStart String RepeatCycleMode String RepeatCycleMode :如果是没有重复的话-1,周一0,周二1,周三2,周四3,周五4,周六5,周日6,例如:重复周期为星期三星期四的话就为23**/8.设置上课隐身接口/*** 开始小时*/private int startHour;/*** 开始分钟*/private int startMinute;/*** 结束小时*/private int endHour;/*** 结束分钟*/private int endMinute;/*** 模式,参考本类静态变量*/private int mode;private String enabled; 表示是否启用字符串1表示启用,0表示不启用}9.获取闹钟接口{"count": 2,"data": [{"alarmsName": "起床","openState": true,"repeatCycleMode": "012","time": "9:00"},{"alarmsName": "午休","openState": false,"repeatCycleMode": "234","time": "10:00"}],"code": 200"msg": 成功}10.设置闹钟接口"alarmsName": "起床","openState": true,"repeatCycleMode": "012","time": "9:00"}11.获取一键拨号接口{"data": [‘’,’2’,’’,’’] //一键拨号注意下标对应按键。
接口文档规范
XXX接口说明书(版本:V1.0)修订记录1简介1.1文档目的接口文档是前端与后端交互密不可分的环节,接口的规范性会直接影响双方对接过程中的效率和质量。
本着快速高效开发的目的性,避免对接过程中的错误率。
1.2接口规范(1) 遵循RESTful API设计风格(2) 数据格式采用json格式(3) 返回统一结构数据例如:结构:data(数据)、errorCode(状态码)、msg(提示信息){data:{}, // 数据类型不一定为object类型errorCode:10001,msg:''}(4) 枚举型参数应列举参数所有值及说明例如:gender:性别(男:1,女:2)userInfo:{name:'张三',age:23,gender:1}(5) 具有嵌套关系的参数应指明嵌套关系及子级数据结构例如:billList: 账单列表(父级)billList:[{id:'001',billName:'测试数据',billStauts:1,address:'雁塔区'}](6) 返回参数数据类型保持一致性例如:billList: 账单列表(有数据)billList:[{id:'001',billName:'测试数据',billStauts:1,address:'雁塔区'}]billList: 账单列表(无数据)billList:[]返回的参数数据类型都为:array(7) 下拉及选择型数据以键值对的形式返回例如:orderOperate:订单操作orderOperate:[{label:'待开票'value:1001},{label:'回款'value:1003}](8) “操作类型”的接口必须返回msg信息内容(9) 返回的展示型数据应具有可用性例如:createTime:生成时间(建议格式){createTime:'2018-8-20 17:00:00'}建议:由于前台处理数据能力较弱,故后台返回的数据尽可能便于前台使用。
接口开发规范
合商云购接口开发规范一、验签Model迭代规范说明:现在接口版本的验签规则为:版本号+APPNAME+Model(序列化)后MD5加密,加密后与请求传递的验签串匹配,验签串相同后才会执行接口方法。
问题:如果接口方增加或者减少验签Model,调用方没有对应修改,验签失败导致程序崩溃。
解决:1.相关验签的Model包括请求和返回,任何人不允许随意修改,如果需要修改,向项目负责人提出修改申请,写明申请日志,格式如下;2.版本迭代问题:验签Model,必须标明注释,包含创建人、创建时间、版本,如下图。
验签Model迭代版本为了对历史版本的支持只允许增加字段、不允许删除和修改字段。
3.接口文档版本更新二、接口版本迭代规范说明:在不影响历史版本正常使用的前提下,保证迭代版本更新。
新的版本接口应考虑历史版本支持。
问题:直接修改版本导致线上历史版本调用错误,从而导致程序崩溃,影响比较直接的为手机端。
手机端发版肯定会有多个历史版本同时在线上使用,出现此问题会导致一部分用户手机端软件打不开或者崩溃。
解决:1.正常情况下只允许版本增加传入参数,并对历史版本参数兼容性考虑。
2.参数类型有变化重载方法。
3.如业务需求改变,不可更改方法名和参数,考虑新接口开发。
GET方法:迭代版本增加参数设置可为空。
V1.0 版本获取商品列表GetProductList(string CategoryCode,int PageIndex,IntPageSize)V2.0 版本GetProductList(string CategoryCode,int PageIndex,Int PageSize,stringUserId=””)2.0版本因业务需求增加UserId参数,设置可为空定义,1.0版本即使不传入UserId也会正常进入执行接口。
POST方法:同一,验签Model。
版本更新对应的验签Model字段只可增加不可删除和修改。
并对增加字段标注版本号、开发人、最好注明因何原因或业务需求增加此字段。
app服务器接口文档
失败:{"result":0, "message":"回复帖子失败"}
8.
url
books123456789.ipmph./books/mobile.zaction?command=postList
参数示例
json={"UserName":"xxx","CircleID":"12","Theme":"xxx","Source":"xxx",”Source”:xxx”,”PageSize”:”10”,”PageIndex”:”1”
"deviceinfo":[{"SiteID":"33","AppVersion":"1.0","TerminalType":"IOS","SysVersion":"IOS5.1","Mac":"0E-A5-98-22-33","NetType":"Wifi","TerminalModel":"Lenovo A520","Resolution":"720*1280","AppType":"TCM"}]}
开发规范说明书V1.0
1.数据库开发规范1.1.数据库表命名数据库的表名采用以下规则进行编排:(一)表的命名规则前缀[2位]_类别[3位]_自定义部分。
前缀第一位说明(h 大额,b 小额,e 网银,m 信息管理,f 备付金)前缀第二位说明(x 外联,w web,c 核心)(二)为了移植方便,适应其他多种数据库的环境,要求表名长度<=16个英文字符。
(三)自定义部分不允许用拼音进行编排。
类别划分举例说明:操作员表:hc_ctl_teller1.2.日期类型的问题Oracle数据库和informix数据库不同,不支持自1899-12-31以来的long型日期处理。
但oracle和informix均支持字符串型的日期处理。
因此要求,对应于数据库表中日期型字段的定义,全部定义为STRING类型。
即:char 变量名[9] ;处理日期的函数(包括年月日转换、计算前后N天的日期、日期之间的天数等通过包装函数进行统一处理)。
格式为:YYYYMMDD1.3.数据库错误宏定义对于数据库操作出现的错误号,除了系统统一定义的宏以外,其他错误号禁止直接用数字描述。
以下均是错误的写法:if ( SQLCODE == -1 )if ( SQLCODE == 1403 )……正确的写法应该为:if ( SQLCODE == SQLDUPDATA )if ( SQLCODE == SQLNOTFOUND )……应用中常用的数据库错误编号的规范:#define SQLNOTFOUND 1403 /* 记录未找到 */#define SQLDUPDATA -1 /* 记录重复 */#define SQLNOTABLE -942 /* 表不存在 */#define SQLNOINDEX -1418 /* 索引不存在 */#define SQLNULLDATA -1405 /* 数据有空值 */这些宏定义将定义在系统公用的头文件(db_oracle.h)中。
- 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": []。