XX接口文档V1.0
制作：yibyli
说明：包含有基本的API格式，带有大纲，目录，页眉
1.登陆
1.1描述
登陆的接口
1.2请求地址
操作
login
协议
HTTP
方式
GET
ULR全径
请求的URL地址的全称
1.3请求参数
序号
参数名
中文名称
必选
数据类型
长度
备注
1
para1
第一个参数
Y
String
20
这个API的第一个参数
2
Para2
第二个参数
N
String
20
这个API的第二个参数
1.4返回数据
序号
返回值
中文名称
备注
1
code
请求状态码
200请求成功,400请求失败(参数有误,等)
2
data
返回数据
数组,数组中可能有键值对
3
result
返回结果
0发送验证码成功,1失败
 
1.5请求URL实例
www.baidu/login?name=xx&password=1010（例子并不可以使用）
1.6返回数据实例
{
    "code":200,
    "data":[
        {
            "result":1
        }
         ]
}
2.API名称
2.1描述
这个API是用来做什么的,以及注意点
2.2请求地址
操作
操作名称
协议
HTTP
方式
GET
地址
请求的URL地址的全称
2.3请求参数
序号
参数名
中文名称
必选
数据类型
百度api接口长度
备注
1
para1
第一个参数
Y
String
20
这个API的第一个参数
2
Para2
第二个参数
N
String
20
这个API的第二个参数
2.4返回数据
序号
返回值
中文名称
备注
1
code
请求状态码
200请求成功,400请求失败(参数有误,等)
2
data
返回数据
数组,数组中可能有键值对
3
result
返回结果
0发送验证码成功,1失败
 
2.5请求URL实例
www.baidu/test?name=xx&password=1010
2.6返回数据实例
{
    "code":200,
    "data":[
        {
            "result":1
        }
         ]
}