首页 接口文档规范

接口文档规范

举报
开通vip

接口文档规范XXX接口说明书(版本:V1.0) 文档编号 保密等级 作者 最后修改日期 审核人 最后审批日期 批准人 最后批准日期 修订记录 日期 版本 修订说明 修订人 1简介1.1文档目的接口文档是前端与后端交互密不可分的环节,接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性,避免对接过程...

接口文档规范
XXX接口 说明 关于失联党员情况说明岗位说明总经理岗位说明书会计岗位说明书行政主管岗位说明书 书(版本:V1.0) 文档编号 保密等级 作者 最后修改日期 审核人 最后审批日期 批准人 最后批准日期 修订记录 日期 版本 修订说明 修订人 1简介1.1文档目的接口文档是前端与后端交互密不可分的环节,接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性,避免对接过程中的错误率。1.2接口规范(1)遵循RESTfulAPI 设计 领导形象设计圆作业设计ao工艺污水处理厂设计附属工程施工组织设计清扫机器人结构设计 风格(2)数据格式采用json格式(3)返回统一结构数据例如:结构:data(数据)、errorCode(状态码)、msg(提示信息){data:{},//数据类型不一定为object类型errorCode:10001,msg:''}(4)枚举型参数应列举参数所有值及说明例如:gender:性别(男:1,女:2)userInfo:{name:'张三',age:23,gender:1}(5)具有嵌套关系的参数应指明嵌套关系及子级数据结构例如:billList:账单列 关于同志近三年现实表现材料材料类招标技术评分表图表与交易pdf视力表打印pdf用图表说话 pdf (父级)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-2017:00:00'}建议:由于前台处理数据能力较弱,故后台返回的数据尽可能便于前台使用。2接口定义2.1特殊接口2.1.1获取服务器sessionKey接口标识:接口地址:https://ww.xxx.com/api/GetSessionKey请求方式:POST请求参数: 参数名 类型 必填 示例值 默认值 描述 a ppt 关于艾滋病ppt课件精益管理ppt下载地图下载ppt可编辑假如ppt教学课件下载triz基础知识ppt ype number 是 1 1 1:e站,2:客户 code string 否 wx.login返回的code输出参数: 参数名 类型 示例值 默认值 描述 errorCode number 100 100:成功,-99:失败,-10:需要登录-20:Session失效 msg string 接口返回的文字消息 data string Api接口返回session值返回示例值:{data:'123456',errorCode:100,msg:''}2.2通用接口2.2.1账单列表接口标识:接口地址:https://ww.xxx.com/api/billList请求方式:POST请求参数: 参数名 类型 必填 示例值 默认值 描述 id number 是 订单id sort string 否 排序 gender number 是 1 1 性别(男:1,女:2) orderList array 否 [...] 订单列表 orderList orderId string 否 订单id orderName string 否 订单名称 isStudent boolean 是 false false 是否学生(是:true,否:false)返回参数: 参数名 类型 示例值 默认值 描述 data array […] 返回的数据 data id string 用户id gender number 1 1 用户性别(男:1,女:2) invoiceTitle string 抬头 address string 地址 billList array [...] 订单列表数据 billList id string 订单id billName string 订单名称 billStauts number 1 1 订单状态(待开票:1,回款:2,核销:3) address string 客户地址 userInfo object {} 用户信息 userInfo name name 用户姓名 age number 用户年龄 gender string 1 1 用户性别(男:1,女:2) errorCode number 状态信息 msg string 信息提示返回示例值:{data:[{id:'1',gender:2,invoiceTitle:'帝国快运',address:'陕西省西安市雁塔区科技路24号',billList:[{id:'001',billName:'测试数据',billStauts:1,address:'雁塔区'},{id:'002',billName:'测试数据02',billStauts:1,address:'高新区'}],userInfo:{name:'张三',age:23,gender:1}},{id:'2',gender:1,invoiceTitle:'圆通快递',address:'陕西省西安市雁塔区科技路24号',billList:[{id:'003',billName:'测试数据',billStauts:1,address:'雁塔区'},{id:'004',billName:'测试数据02',billStauts:2,address:'高新区'}],userInfo:{name:'张三',age:23,gender:1}}],errorCode:10001,msg:''}(此文档部分内容来源于网络,如有侵权请告知删除,文档可自行编辑修改内容,供参考,感谢您的支持)
本文档为【接口文档规范】,请使用软件OFFICE或WPS软件打开。作品中的文字与图均可以修改和编辑, 图片更改请在作品中右键图片并更换,文字修改请直接点击文字进行修改,也可以新增和删除文档中的内容。
该文档来自用户分享,如有侵权行为请发邮件ishare@vip.sina.com联系网站客服,我们会及时删除。
[版权声明] 本站所有资料为用户分享产生,若发现您的权利被侵害,请联系客服邮件isharekefu@iask.cn,我们尽快处理。
本作品所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用。
网站提供的党政主题相关内容(国旗、国徽、党徽..)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
下载需要: 免费 已有0 人下载
最新资料
资料动态
专题动态
机构认证用户
爱赢
公司经营范围:网络软件设计、制作、图文设计、影视制作(编辑)
格式:doc
大小:108KB
软件:Word
页数:0
分类:企业经营
上传时间:2020-10-20
浏览量:0