API接口文档(简单版)_第1页
API接口文档(简单版)_第2页
API接口文档(简单版)_第3页
API接口文档(简单版)_第4页
全文预览已结束

下载本文档

版权说明：本文档由用户提供并上传，收益归属内容提供方，若内容存在侵权，请进行举报或认领

文档简介

XX接口文档 V1.0XX接口文档V1.0制作：yibyli说明：包含有基本的API格式，带有大纲，目录，页眉目录目录21.登陆21.1描述21.2请求地址21.3请求参数21.4返回数据21.5请求URL实例21.6返回数据实例32.API名称32.1描述32.2请求地址32.3请求参数32.4返回数据32.5请求URL实例32.6返回数据实例31. 登陆1.1 描述登陆的接口1.2 请求地址操作login协议HTTP方式GETULR全径请求的URL地址的全称1.3 请求参数序号参数名中文名称必选数据类型长度备注1para1第一个参数YString20这个API的第一个参数2Para2第二个参数NString20这个API的第二个参数1.4 返回数据序号返回值中文名称备注1code请求状态码200请求成功,400请求失败(参数有误,等)2data返回数据数组,数组中可能有键值对3result返回结果0发送验证码成功,1失败 1.5 请求URL实例/login?name=xx&password=1010（例子并不可以使用）1.6 返回数据实例code:200,data:result:1 2. API名称2.1 描述这个API是用来做什么的,以及注意点2.2 请求地址操作操作名称协议HTTP方式GET地址请求的URL地址的全称2.3 请求参数序号参数名中文名称必选数据类型长度备注1para1第一个参数YString20这个API的第一个参数2Para2第二个参数NString20这个API的第二个参数2.4 返回数据序号返回值中文名称备注1code请求状态码200请求成功,400请求失败(参数有误,等)2data返回数据数组,数组中可能有键值对3result返回结果0发送验证码成功,1失败 2.5 请求URL实例/test?name=xx&pass
人人文库> 全部分类> 应用文书 > 事务文书

温馨提示

  • 1. 本站所有资源如无特殊说明，都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等，如果需要附件，请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸，网页内容里面会有图纸预览，若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间，仅对用户上传内容的表现方式做保护处理，对用户上传分享的文档内容本身不做任何修改或编辑，并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容，请与我们联系，我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论