什么是接口文檔？
在項目期間，前后端是分離開發的，為了前后有連貫性，就必須由前后開發工程師共同定義接口、寫接口文檔再根據接口文檔去開發，一直到項目結束。
接口文檔規范
-
方法
也就是我們常寫的新增，刪除，修改，查詢
-
url
調用方法，一般是從前端調后端的方法地址
-
請求參數
一般分五列：字段、說明、類型、備注、是否必填
-
返回參數
1、如果只返回接口調用成功還是失敗（新增、刪除、修改等），則只有一個結構體：
code和message兩個參數；
2、如果要返回某些參數，則有兩個結構體：
是code/mesage/data；
是data里寫返回的參數,data是object類型；
3、如果要返回列表，那么有三個結構體，
是code/mesage/data,data是object，里面放置page/size/total/totalPage/list 5個參數，其中list是Arrary類型，list里放object，object里是具體的參數。
了解目的
- 用戶登錄
- 用戶注冊
- 樹形菜單
- 文章查詢
- 文章新增
- 文章修改
- 文章刪除
用戶登錄：
接口調用and請求
http請求方式: POST （一般有兩種get/post） https://xxx.xxx.xxx:8080/項目命名/vue/userAction_login.action
| 字段 | 說明 | 類型 | 是否必填 |
| uname | 名字 | String | 是 |
| pwd | 密碼 | String | 是 |
登錄成功返回JSON數據包:
{ "msg":"登錄成功", "result":{ "uname":"用戶名", "pwd":"密碼" }, "code":1 }
用戶或者密碼為空返回JSON數據包:
{ "msg":"用戶或者密碼為空", "result":{ "uname":"用戶名", "pwd":"密碼" }, "code":0 }
用戶或者密碼錯誤返回JSON數據包:
{ "msg":"用戶或者密碼錯誤", "result":{ "uname":"用戶名", "pwd":"密碼" }, "code":0 }
| 參數 |
說明 |
| msg |
提示消息 |
| result |
返回登錄的用戶名和密碼 |
| code |
狀態 0：登錄失敗 1：登錄成功 |
用戶注冊
接口調用
https://xxx.xxx.xxx:8080/項目命名/vue/userAction_reg.action
| 字段 | 說明 | 類型 | 是否必填 |
| uname | 名字 | String | 是 |
| pwd | 密碼 | String | 是 |
注冊返回JSON數據包：
{
"msg":"用戶注冊成功",
"code":1
}
用戶注冊失敗返回JSON數據包：
{
"msg":"用戶注冊失敗",
"code":0
}
| 參數 |
說明 |
| msg |
提示消息 |
| code |
狀態碼 0：失敗 1：成功 |
樹形菜單
調用接口
https://xxx.xxx.xxx:8080/項目命名/vue/treeNodeAction.action
返回的json數據表如下：
{ "msg": "操作成功", "result": [ { "treeNodeId": 1, "treeNodeName": "系統管理", "treeNodeType": 1, "url": null, "position": 1, "icon": "el-icon-setting", "children": [ { "treeNodeId": 2, "treeNodeName": "用戶管理", "treeNodeType": 2, "url": "/sys/VuexPage1", "position": 2, "icon": "el-icon-user", "children": [] }, { "treeNodeId": 3, "treeNodeName": "角色管理", "treeNodeType": 2, "url": "/sys/VuexPage2", "position": 3, "icon": "", "children": [] }, { "treeNodeId": 4, "treeNodeName": "密碼修改", "treeNodeType": 2, "url": null, "position": 4, "icon": null, "children": [] } ] }, { "treeNodeId": 5, "treeNodeName": "論壇管理", "treeNodeType": 1, "url": null, "position": 5, "icon": "el-icon-reading", "children": [ { "treeNodeId": 6, "treeNodeName": "文章管理", "treeNodeType": 2, "url": "/sys/Articles", "position": 6, "icon": null, "children": [] } ] } ], "code": 1 }
| 參數 |
說明 |
| msg |
提示消息 |
| result |
返回樹形菜單結果集 |
| code |
狀態 0：失敗 1：成功 |
Result樹形菜單結果集
| 參數 |
說明 |
| treeNodeId |
菜單id |
| treeNodeName |
菜單名 |
| treeNodeType |
菜單類型 1：父菜單2：跳轉菜單 |
| url |
路由地址 |
| icon |
菜單圖標 |
| children |
子菜單集，如果沒有則為一個空json數組 |
文章查詢
調用接口
https://xxx.xxx.xxx:8080/項目命名/vue/articleAction_list.action
| 參數 |
是否必填 |
說明 |
| page |
否 |
當前頁碼，默認為1 |
| rows |
否 |
一頁展示多少條數據，默認為10 |
| title |
否 |
按文章標題查詢 |
返回json數據包說明：
{ "result":[{"id":1,"title":"文章標題","body":"文章內容"], "pageBean":{ "page":1, "rows":10, "total":100, } }
result結果集
| 參數 |
說明 |
| id |
文章id |
| title |
文章標題 |
| body |
文章內容 |
pageBean 分頁對象說明
| 參數 |
說明 |
| page |
當前頁碼 |
| rows |
一頁展示的條數 |
| total |
總條數 |
文章添加
調用接口
https://xxx.xxx.xxx:8080/項目命名/vue/articleAction_add.action
| 參數 |
是否必填 |
說明 |
| title |
是 |
文章標題 |
| Body |
否 |
文章內容 |
添加成功返回JSON數據包：
{"msg":"新增成功","result":[],"code":1}
添加失敗返回JSON數據包：
{"msg":"新增失敗","result":[],"code":0}
| 參數 |
說明 |
| msg |
提示消息 |
| code |
狀態碼 0：失敗 1：成功 |
文章修改
調用接口
https://xxx.xxx.xxx:8080/項目命名/vue/articleAction_edit.action
| 參數 |
是否必須 |
說明 |
| id |
是 |
文章id |
| title |
否 |
文章標題 |
| body |
否 |
文章內容 |
修改成功返回JSON數據包：
{"msg":"修改成功","code":1}
修改失敗返回JSON數據包：
{"msg":"修改失敗","code":0}
| 參數 |
說明 |
| msg |
提示消息 |
| code |
狀態碼 0：失敗 1：成功 |
文章刪除
調用接口
https://xxx.xxx.xxx:8080/項目命名/vue/articleAction_del.action
| 參數 |
是否必須 |
說明 |
| id |
是 |
文章id |
刪除成功返回JSON數據包：
{"msg":"刪除成功","code":1}
刪除失敗返回JSON數據包：
{"msg":"刪除失敗","code":0}
| 參數 |
說明 |
| msg |
提示消息 |
| code |
狀態碼 0：失敗 1：成功 |
謝謝觀看！