文章出自:博客园 开发的安卓或者ios的朋友们,经常会遇到想测试但是没有公开的api接口进行进行测试。但自己又不会开发服务端或者没有服务器,这里我免费提供了一整套API接口。欢迎大家调用,目标是方便大家。 API接口的测试地址为:http://www.meixintong.net/api_test.jsp。下面是整个API接口文档(后续会增多接口): 目录 1. 通用... 3 1.1. 通信协议... 3 1.2. 请求URL. 3 1.3. 返回格式... 3 1.4. Session校验... 3 1.5. 测试网址... 3 1.6. 错误编码... 3 2. 账号登陆... 4 2.1. 请求URI 4 2.2. 请求参数... 4 2.3. 返回信息... 4 3. 修改密码(个人). 4 3.1. 请求URI 4 3.2. 请求参数... 4 3.3. 返回信息... 4 4. 注册新用户... 5 4.1. 请求URI 5 4.2. 请求参数... 5 4.3. 返回信息... 5 5. 获取菜单... 5 5.1. 请求URI 5 5.2. 请求参数... 5 5.3. 返回信息... 5 6. 注销登录... 6 6.1. 请求URI 6 6.2. 请求参数... 6 6.3. 返回信息... 6
1. 通用1.1. 通信协议- 采用HTTP协议,并必须使用POST请求。
- http:// 114.215.172.87/
- 返回格式统一使用json数组格式返回。
- 请求正确时,state对应值为true,data对应值为返回的信息。
- 请求返回异常或者错误时,state对应值为false,errorCode对应值为返回的错误编码。
- 无论请求正确、异常或者错误,都返回logCode(日志编码)。用于方便在服务器端查找此次请求的日志。
- 除用户登录、用户注册外其余操作,都需要先登录再操作。且多个请求需使用同一个httpclient,8小时无请求后再次请求会返回超时重新登录。
- http://114.215.172.87/api_test.jsp
1.2. 请求URL1.3. 返回格式1.4. Session校验1.5. 测试网址1.6. 错误编码错误编码 | 含义 | 备注 | -1 | 用户名或者密码错误 |
| -2 | 账号被锁定 |
| -3 | 用户名已经存在 |
| -4 | 注册新用户时内部异常 |
| -5 | session超时需重新登录 |
|
|
|
|
|
|
|
2. 账号登陆2.1. 请求URI2.2. 请求参数参数名 | 内容 | 是否必传 | 备注 | userName | 用户名 | 是 |
| userPwd | 用户密码 | 是 |
|
|
|
|
| 2.3. 返回信息- 错误或异常返回对应编码。
- 正确时返回User对象,但roleId为空,roleId保存在userPwd变量上。
- /api/updateMyPassword
3. 修改密码(个人)3.1. 请求URI3.2. 请求参数参数名 | 内容 | 是否必传 | 备注 | oldPwd | 老密码 | 是 |
| newPwd | 新密码 | 是 |
| 3.3. 返回信息- 错误或异常返回对应编码。
- 正确时data无数据返回。
- /login/apiReg
4. 注册新用户4.1. 请求URI4.2. 请求参数参数名 | 内容 | 是否必传 | 备注 | userName | 用户名 | 是 |
| userPwd | 密码 | 是 |
|
|
|
|
| 4.3. 返回信息- 错误或异常返回对应编码。
- 正确时data无数据返回。
- /api/getMenu
5. 获取菜单5.1. 请求URI5.2. 请求参数5.3. 返回信息- 错误或异常返回对应编码。
- 正确时data为拥有的菜单集合。
- /login/apiLogOut
6. 注销登录6.1. 请求URI6.2. 请求参数6.3. 返回信息
|