インタフェースのドキュメントとは何ですか？
プロジェクト中に、前方及び後方端部が前後に一貫性を持たせるために、開発から分離され、プロジェクトが終了するまで、共通のインターフェイスは、文書に従ってインターフェイスを開発するために再度書き込むためにフロントとリア開発エンジニア、インターフェースドキュメントから成る定義する必要があります。
ドキュメントインタフェース仕様
-
方法
つまり、私たちはしばしば、追加、削除、変更、クエリ書きます
-
URL
メソッドを呼び出し、一般後端アドレス方式の前端から転送され
-
リクエストパラメータ
フィールド、説明、タイプ、メモ、必要な場合：一般的に5分割
-
リターン・パラメータ
1、インターフェースは（など、変更、削除、追加）呼び出しが成功したか失敗した場合にのみ返し、一つだけの構造：
そして2つのメッセージコードパラメータ。
あなたには、いくつかのパラメータに戻したい場合は2、、2つの構造があります。
是コード/メッセージを指定/データ。
パラメータデータをリターンに書き込まれる、データオブジェクト型です。
あなたがリストを返すようにしたい場合は3、そして3つの構造があり、
コード/メッセージを指定/データ、データがリストのタイプArraryである5つのパラメータ、ページ/サイズ/合計/ TOTALPAGE /リストが配置されたオブジェクトである、特定のパラメータにリストオブジェクト、オブジェクトを置きます。
了解目的
- ユーザーログイン
- ユーザー登録
- ツリーメニュー
- 記事のお問い合わせ
- 新しい記事
- テキスト改訂
- 記事の削除
ユーザーログイン：
インタフェースの呼び出しと要求
HTTPリクエストメソッド：POST（2種類/ POSTをGETあります） /vue/userAction_login.action名付けhttps://xxx.xxx.xxx:8080/プロジェクト
| フィールド | 説明 | タイプ | 必須 |
| uname | 名前 | 弦 | それはあります |
| PWD | パスワード | 弦 | それはあります |
成功したリターンJSONデータパケットログイン：
{
" メッセージ"：" 成功したログイン" 、
" 結果" ：{
" は、uname "：" ユーザ名" 、
" PWD "：" パスワード"
}、
" コード"：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：成功 |
谢谢观看！