api接口文档(简单版)

《api接口文档(简单版)》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、XX接口文档V1.0XX接口文档V1.0制作：yibyli说明：包含有基本的API格式，带有大纲，目录，页眉4XX接口文档V1.0目录目录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请求参数序号参数名中文名称必选数据类型长度备注1para

2、1第一个参数YString20这个API的第一个参数2Para2第二个参数NString20这个API的第二个参数1.4返回数据序号返回值中文名称备注1code请求状态码200请求成功,400请求失败(参数有误,等)2data返回数据数组,数组中可能有键值对3result返回结果0发送验证码成功,1失败1.5请求URL实例4XX接口文档V1.0http://www.baidu.com/login?name=xx&password=1010（例子并不可以使用）1.1返回数据实例{    "code":200,    "data":[   

3、     {            "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返回数据数组,数组中可能有键值对3

4、result返回结果0发送验证码成功,1失败2.5请求URL实例http://www.baidu.com/test?name=xx&password=10102.6返回数据实例{    "code":200,    "data":[        {            "result":1        }    ]4XX接口文档V1.0}4