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

XX接口文档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实例（例子并不可以使用）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实例2.6 返回数据实例{    "code":200,    "data":[        {            "result":1        }     ]}。