API接口文档(简单版).doc

《API接口文档(简单版).doc》由会员分享，可在线阅读，更多相关《API接口文档(简单版).doc（4页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、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第二个

2、参数NString20这个API的第二个参数1.4 返回数据序号返回值中文名称备注1code请求状态码200请求成功,400请求失败(参数有误,等)2data返回数据数组,数组中可能有键值对3result返回结果0发送验证码成功,1失败 1.5 请求URL实例1.6 返回数据实例code:200,data:result:1 2. API名称2.1 描述这个API是用来做什么的,以及注意点2.2 请求地址操作操作名称协议HTTP方式GET地址请求的URL地址的全称2.3 请求参数序号参数名中文名称必选数据类型长度备注1para1第一个参数YString20这个API的第一个参数2Para2第二个

3、参数NString20这个API的第二个参数2.4 返回数据序号返回值中文名称备注1code请求状态码200请求成功,400请求失败(参数有误,等)2data返回数据数组,数组中可能有键值对3result返回结果0发送验证码成功,1失败 2.5 请求URL实例2.6 返回数据实例code:200,data:result:1 4 0 & /. /实 失,码结 值有中组数 等,数败求,求态 备名回序数参二的 参 参个 参 备长类必名数序参全址 地 方 协名操地意及,什用 描名 : . , 实实 失,功结 值有能数 等.误参失请/,成 态 备名码回序 数参个有 参 数参一的, 参 名备长类必名二数的序参全址参地全 个方 协 操地参接描备登 必 序0 地实据 地 及 用 描 _ 实 请 0 . 0 参. 0 址求 0 述 _ 称 . 0 例回 _ _ 实 00 _ 0 据返 数 0 地请 _ 描. 0 _ 陆 0 录 0 - 目眉，录有带 的含 . 口 * 含 ，目 0 请 数 0 _ 回 址 0. 据 接操方全参数必备 一 参数备,参 有 结失 : 4