接口文档规范.doc
《接口文档规范.doc》由会员分享,可在线阅读,更多相关《接口文档规范.doc(11页珍藏版)》请在咨信网上搜索。
1、XXX接口说明书(版本:V1.0)文 档 编 号保 密 等 级作 者最后修改日期审 核 人最后审批日期批 准 人最后批准日期修订记录日期版本修订说明修订人1 简介1.1 文档目的 接口文档是前端与后端交互密不可分的环节,接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性,避免对接过程中的错误率。1.2 接口规范(1) 遵循RESTful API设计风格(2) 数据格式采用json格式(3) 返回统一结构数据例如:结构:data(数据)、errorCode(状态码)、msg(提醒信息) data: , / 数据类型不一定为object类型 errorCode: 10001
2、, 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: 雁
3、塔区 billList: 账单列表(无数据) billList: 返回的参数数据类型都为:array(7) 下拉及选择型数据以键值对的形式返回例如:orderOperate:订单操作 orderOperate: label: 待开票 value: 1001, label: 回款 value: 1003 (8) “操作类型”的接口必须返回msg信息内容(9) 返回的展示型数据应具有可用性例如:createTime:生成时间(建议格式) createTime: 2023-8-20 17:00:00建议:由于前台解决数据能力较弱,故后台返回的数据尽也许便于前台使用。2 接口定义2.1 特殊接口2.1
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 接口 文档 规范
1、咨信平台为文档C2C交易模式,即用户上传的文档直接被用户下载,收益归上传人(含作者)所有;本站仅是提供信息存储空间和展示预览,仅对用户上传内容的表现方式做保护处理,对上载内容不做任何修改或编辑。所展示的作品文档包括内容和图片全部来源于网络用户和作者上传投稿,我们不确定上传用户享有完全著作权,根据《信息网络传播权保护条例》,如果侵犯了您的版权、权益或隐私,请联系我们,核实后会尽快下架及时删除,并可随时和客服了解处理情况,尊重保护知识产权我们共同努力。
2、文档的总页数、文档格式和文档大小以系统显示为准(内容中显示的页数不一定正确),网站客服只以系统显示的页数、文件格式、文档大小作为仲裁依据,平台无法对文档的真实性、完整性、权威性、准确性、专业性及其观点立场做任何保证或承诺,下载前须认真查看,确认无误后再购买,务必慎重购买;若有违法违纪将进行移交司法处理,若涉侵权平台将进行基本处罚并下架。
3、本站所有内容均由用户上传,付费前请自行鉴别,如您付费,意味着您已接受本站规则且自行承担风险,本站不进行额外附加服务,虚拟产品一经售出概不退款(未进行购买下载可退充值款),文档一经付费(服务费)、不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
4、如你看到网页展示的文档有www.zixin.com.cn水印,是因预览和防盗链等技术需要对页面进行转换压缩成图而已,我们并不对上传的文档进行任何编辑或修改,文档下载后都不会有水印标识(原文档上传前个别存留的除外),下载后原文更清晰;试题试卷类文档,如果标题没有明确说明有答案则都视为没有答案,请知晓;PPT和DOC文档可被视为“模板”,允许上传人保留章节、目录结构的情况下删减部份的内容;PDF文档不管是原文档转换或图片扫描而得,本站不作要求视为允许,下载前自行私信或留言给上传者【w****g】。
5、本文档所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用;网站提供的党政主题相关内容(国旗、国徽、党徽--等)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
6、文档遇到问题,请及时私信或留言给本站上传会员【w****g】,需本站解决可联系【 微信客服】、【 QQ客服】,若有其他问题请点击或扫码反馈【 服务填表】;文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“【 版权申诉】”(推荐),意见反馈和侵权处理邮箱:1219186828@qq.com;也可以拔打客服电话:4008-655-100;投诉/维权电话:4009-655-100。