バックグラウンドインタフェースのドキュメントの書き方を教えてあげます

文書ディレクトリ

ユーザー登録

ユーザ登録

左側のツリーメニュー

をロード

記事照会

記事新規

記事修正

記事削除

ユーザーログイン

http    : POST

https://xxx.xxx.xxx:8080/    /vue/userAction_login.action

パラメータ
必要かどうか
説明
Name
はい
ユーザー名
Pwd
はい
パスワード
ログインによりjsonデータが正常に返されました:

code: 1
msg: "    "
result: {uname: "zs", pwd: "123"}

ログインに失敗してjsonデータを返します.

code: 0
msg: "        "
result: {uname: "zss", pwd: "123"}

パラメータ
説明
code
ステータスコード1ログイン成功0ログイン失敗
msg
ヒントメッセージ
result
返されるログイン名とパスワード
ユーザー登録

http    : POST

https://xxx.xxx.xxx:8080/    vue/userAction_reg.action

パラメータ
必要かどうか
説明
uname
はい
登録名
pwd
はい
パスワード
登録は正常にjsonデータを返しました:

1.  code: 1
2.  msg: "    "

登録に失敗してjsonデータを返します.

1.  code: 0
2.  msg: "    "

パラメータ
説明
code
状態1.登録に成功しました2.登録に失敗しました
msg
ヒント
左側のツリーメニューの読み込み

http    : POST
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
要求ステータスコード、1成功2失敗
resultメニュー結果セット
パラメータ
説明
treeNodeId
メニューのid
treeNodeName
メニュー名
treeNodeType
メニュータイプ1親メニュー2ジャンプメニュー
url
ルーティングアドレス
position
位置
icon
メニューアイコン
children
サブメニューの単一セット、ない場合は空のjson配列
文書照会

http    : POST
https://xxx.xxx.xxx:8080/    vue/articleAction_list.action

パラメータ
必要かどうか
説明
page
いいえ
現在のページ番号、デフォルトは1
rows
いいえ
1ページに何個のデータが表示され、デフォルトは10です.
title
いいえ
ある場合は記事のタイトルに従ってあいまいなクエリーを行い、このパラメータがない場合はすべてクエリーします.
jsonパケットの説明を返します.

{
	"result":[{"id":15,"title":"solr  ","body":"solr     ，   lucene     "],
	"pageBean":{
		"page":2,
		"rows":1,
		"total":0,
	}
}

result結果セットの説明
パラメータ
説明
id
文章のid
title
見出し
body
内容
PageBean結果説明
page
現在のページ番号
rows
1ページに表示されるデータの数
total
合計何件のデータが検出されましたか
記事の新規作成

http    : POST
https://xxx.xxx.xxx:8080/    vue/articleAction_add.action

パラメータ
必要かどうか
説明
title
はい
記事タイトル
body
はい
文章の内容
jsonパケットに戻ると、新規成功

{"msg":"    ",
"result":[],
"code":1
}

新規作成に失敗しました

{"msg":"    ",
"result":[],
"code":0
}

パラメータ
説明
msg
ヒント
code
ステータスコード1成功0失敗
文章の修正

http    : POST
https://xxx.xxx.xxx:8080/    vue/articleAction_edit.action

パラメータ
必要かどうか
説明
id
はい
記事id
title
いいえ
見出し
body
いいえ
内容
jsonパケットを返して変更に成功したことを示します

{"msg":"    ","code":1}

変更に失敗しました

{"msg":"    ","code":0}

パラメータ
説明
msg
ヒントメッセージ
code
ステータスコード1成功0失敗
記事の削除

http    : POST
https://xxx.xxx.xxx:8080/    vue/articleAction_del.action

パラメータ
必要かどうか
説明
id
はい
削除されたid
jsonパケットの説明を返します
削除に成功しました

{"msg":"    ","code":1}

削除に失敗しました

{"msg":"    ","code":0}

パラメータ
説明
msg
ヒントメッセージ
code
ステータスコード1成功0失敗