各位博友好!開發的安卓或者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. 請求URL
1.3. 返回格式
1.4. Session校驗
1.5. 測試網址
1.6. 錯誤編碼
錯誤編碼 |
含義 |
備注 |
-1 |
用戶名或者密碼錯誤 |
|
-2 |
賬號被鎖定 |
|
-3 |
用戶名已經存在 |
|
-4 |
注冊新用戶時內部異常 |
|
-5 |
session超時需重新登錄 |
|
|
|
|
|
|
|
2. 賬號登陸
- 2.
- /login/apiLogin
2.1. 請求URI
2.2. 請求參數
參數名 |
內容 |
是否必傳 |
備注 |
userName |
用戶名 |
是 |
|
userPwd |
用戶密碼 |
是 |
|
|
|
|
|
2.3. 返回信息
- 錯誤或異常返回對應編碼。
- 正確時返回User對象,但roleId為空,roleId保存在userPwd變量上。
- 3.
- /api/updateMyPassword
3. 修改密碼(個人)
3.1. 請求URI
3.2. 請求參數
參數名 |
內容 |
是否必傳 |
備注 |
oldPwd |
老密碼 |
是 |
|
newPwd |
新密碼 |
是 |
|
3.3. 返回信息
- 錯誤或異常返回對應編碼。
- 正確時data無數據返回。
- 4.
- /login/apiReg
4. 注冊新用戶
4.1. 請求URI
4.2. 請求參數
參數名 |
內容 |
是否必傳 |
備注 |
userName |
用戶名 |
是 |
|
userPwd |
密碼 |
是 |
|
|
|
|
|
4.3. 返回信息
- 錯誤或異常返回對應編碼。
- 正確時data無數據返回。
- 5.
- /api/getMenu
5. 獲取菜單
5.1. 請求URI
5.2. 請求參數
參數名 |
內容 |
是否必傳 |
備注 |
|
|
|
|
|
|
|
|
|
|
|
|
5.3. 返回信息
- 錯誤或異常返回對應編碼。
- 正確時data為擁有的菜單集合。
- 6.
- /login/apiLogOut
6. 注銷登錄
6.1. 請求URI
6.2. 請求參數
參數名 |
內容 |
是否必傳 |
備注 |
|
|
|
|
|
|
|
|
|
|
|
|
6.3. 返回信息
- 錯誤或異常返回對應編碼。
- 正確時data為空。