API接口文档(简单版).doc
文本预览下载声明
XX接口文档 V1.0
PAGE \* MERGEFORMAT1
XX接口文档V1.0
制作:yibyli
说明:包含有基本的API格式,带有大纲,目录,页眉
目录
TOC \o 1-3 \h \z \u HYPERLINK \l _Toc458079684 目录 PAGEREF _Toc458079684 \h 2
HYPERLINK \l _Toc458079685 1. 登陆 PAGEREF _Toc458079685 \h 2
HYPERLINK \l _Toc458079686 1.1 描述 PAGEREF _Toc458079686 \h 2
HYPERLINK \l _Toc458079687 1.2 请求地址 PAGEREF _Toc458079687 \h 2
HYPERLINK \l _Toc458079688 1.3 请求参数 PAGEREF _Toc458079688 \h 2
HYPERLINK \l _Toc458079689 1.4 返回数据 PAGEREF _Toc458079689 \h 2
HYPERLINK \l _Toc458079690 1.5 请求URL实例 PAGEREF _Toc458079690 \h 2
HYPERLINK \l _Toc458079691 1.6 返回数据实例 PAGEREF _Toc458079691 \h 3
HYPERLINK \l _Toc458079692 2. API名称 PAGEREF _Toc458079692 \h 3
HYPERLINK \l _Toc458079693 2.1 描述 PAGEREF _Toc458079693 \h 3
HYPERLINK \l _Toc458079694 2.2 请求地址 PAGEREF _Toc458079694 \h 3
HYPERLINK \l _Toc458079695 2.3 请求参数 PAGEREF _Toc458079695 \h 3
HYPERLINK \l _Toc458079696 2.4 返回数据 PAGEREF _Toc458079696 \h 3
HYPERLINK \l _Toc458079697 2.5 请求URL实例 PAGEREF _Toc458079697 \h 3
HYPERLINK \l _Toc458079698 2.6 返回数据实例 PAGEREF _Toc458079698 \h 3
登陆
描述
登陆的接口
请求地址
操作
login
协议
HTTP
方式
GET
ULR全径
请求的URL地址的全称
请求参数
序号
参数名
中文名称
必选
数据类型
长度
备注
1
para1
第一个参数
Y
String
20
这个API的第一个参数
2
Para2
第二个参数
N
String
20
这个API的第二个参数
返回数据
序号
返回值
中文名称
备注
1
code
请求状态码
200请求成功,400请求失败(参数有误,等)
2
data
返回数据
数组,数组中可能有键值对
3
result
返回结果
0发送验证码成功,1失败
请求URL实例
HYPERLINK /login?name=xxpassword=1010 /login?name=xxpassword=1010(例子并不可以使用)
返回数据实例
{????code:200,????data:[????????{????????????result:1????????}??? ?]}
API名称
描述
这个API是用来做什么的,以及注意点
请求地址
操作
操作名称
协议
HTTP
方式
GET
地址
请求的URL地址的全称
请求参数
序号
参数名
中文名称
必选
数据类型
长度
备注
1
para1
第一个参数
Y
String
20
这个API的第一个参数
2
Para2
第二个参数
N
String
20
这个API的第二个参数
返回数据
序号
返回值
中文名称
备注
1
code
请求状态码
200请求成功,400请求失败(参数有误,等)
2
data
返回数据
数组,数组中可能有键值对
3
result
返回结果
0发送验证码成功,1失败
请求URL实例
/test?name=xxpassword=1010
返回数据实例
{????code:200,????data:[????????{????????????result:1????????}??? ?]}
显示全部