mirror of
https://gitee.com/bookshelfplus/bookshelfplus
synced 2025-10-02 22:15:15 +08:00
重新引入Redis;用户登录与管理员登录完成;引入NanoID代替UUID;调整Spring Boot idea中的启动参数;swagger页面描述信息完善;更新swagger,更新Api文档
This commit is contained in:
@@ -18,9 +18,10 @@ __域名__ : localhost:8090
|
||||
|
||||
=== 标签
|
||||
|
||||
* book-controller : Book Controller
|
||||
* status-controller : Status Controller
|
||||
* user-controller : User Controller
|
||||
* 书籍信息 : Book Controller
|
||||
* 书籍分类信息 : Category Controller
|
||||
* 用户操作 : User Controller
|
||||
* 网站后台状态检测 : Status Controller
|
||||
|
||||
|
||||
|
||||
@@ -28,8 +29,8 @@ __域名__ : localhost:8090
|
||||
[[_paths]]
|
||||
== 资源
|
||||
|
||||
[[_book-controller_resource]]
|
||||
=== Book-controller
|
||||
[[_261c63557a0a2affe4e9ee7cf30075c0]]
|
||||
=== 书籍信息
|
||||
Book Controller
|
||||
|
||||
|
||||
@@ -91,20 +92,35 @@ __必填__|id|integer (int32)
|
||||
----
|
||||
|
||||
|
||||
[[_status-controller_resource]]
|
||||
=== Status-controller
|
||||
Status Controller
|
||||
|
||||
|
||||
[[_getusingget_1]]
|
||||
==== 系统状态
|
||||
[[_searchusingget]]
|
||||
==== 查询书籍列表
|
||||
....
|
||||
GET /api/status/get
|
||||
GET /api/book/search
|
||||
....
|
||||
|
||||
|
||||
===== 说明
|
||||
获取服务器当前系统负载。SystemLoadAverage返回-1时代表不支持。
|
||||
通过指定条件查询书籍列表
|
||||
|
||||
|
||||
===== 参数
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|类型|名称|说明|类型
|
||||
|**Query**|**author** +
|
||||
__可选__|author|string
|
||||
|**Query**|**bookName** +
|
||||
__可选__|bookName|string
|
||||
|**Query**|**categoryId** +
|
||||
__可选__|categoryId|integer (int32)
|
||||
|**Query**|**id** +
|
||||
__可选__|id|integer (int32)
|
||||
|**Query**|**language** +
|
||||
__可选__|language|string
|
||||
|**Query**|**publishingHouse** +
|
||||
__可选__|publishingHouse|string
|
||||
|===
|
||||
|
||||
|
||||
===== 响应
|
||||
@@ -128,7 +144,7 @@ GET /api/status/get
|
||||
|
||||
====== 请求 path
|
||||
----
|
||||
/api/status/get
|
||||
/api/book/search
|
||||
----
|
||||
|
||||
|
||||
@@ -144,11 +160,132 @@ GET /api/status/get
|
||||
----
|
||||
|
||||
|
||||
[[_user-controller_resource]]
|
||||
=== User-controller
|
||||
[[_82c2171949c312f17a084ab9b31e7d55]]
|
||||
=== 书籍分类信息
|
||||
Category Controller
|
||||
|
||||
|
||||
[[_getusingget_1]]
|
||||
==== 获取书籍分类
|
||||
....
|
||||
GET /api/category/get
|
||||
....
|
||||
|
||||
|
||||
===== 说明
|
||||
获取书籍分类
|
||||
|
||||
|
||||
===== 参数
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|类型|名称|说明|类型
|
||||
|**Query**|**id** +
|
||||
__必填__|id|integer (int32)
|
||||
|===
|
||||
|
||||
|
||||
===== 响应
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP代码|说明|类型
|
||||
|**200**|OK|<<_commonreturntype,CommonReturnType>>
|
||||
|**401**|Unauthorized|无内容
|
||||
|**403**|Forbidden|无内容
|
||||
|**404**|Not Found|无内容
|
||||
|===
|
||||
|
||||
|
||||
===== 生成
|
||||
|
||||
* `\*/*`
|
||||
|
||||
|
||||
===== HTTP请求示例
|
||||
|
||||
====== 请求 path
|
||||
----
|
||||
/api/category/get?id=0
|
||||
----
|
||||
|
||||
|
||||
===== HTTP响应示例
|
||||
|
||||
====== 响应 200
|
||||
[source,json]
|
||||
----
|
||||
{
|
||||
"data" : "object",
|
||||
"status" : "string"
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
[[_9083a36b9e1b060bcb75ff62bb4bda37]]
|
||||
=== 用户操作
|
||||
User Controller
|
||||
|
||||
|
||||
[[_getuserstatususingget]]
|
||||
==== 获取用户登录状态
|
||||
....
|
||||
GET /api/user/getUserStatus
|
||||
....
|
||||
|
||||
|
||||
===== 说明
|
||||
获取用户登录状态
|
||||
|
||||
|
||||
===== 参数
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|类型|名称|说明|类型
|
||||
|**Query**|**token** +
|
||||
__必填__|token|string
|
||||
|===
|
||||
|
||||
|
||||
===== 响应
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP代码|说明|类型
|
||||
|**200**|OK|<<_commonreturntype,CommonReturnType>>
|
||||
|**401**|Unauthorized|无内容
|
||||
|**403**|Forbidden|无内容
|
||||
|**404**|Not Found|无内容
|
||||
|===
|
||||
|
||||
|
||||
===== 生成
|
||||
|
||||
* `\*/*`
|
||||
|
||||
|
||||
===== HTTP请求示例
|
||||
|
||||
====== 请求 path
|
||||
----
|
||||
/api/user/getUserStatus?token=string
|
||||
----
|
||||
|
||||
|
||||
===== HTTP响应示例
|
||||
|
||||
====== 响应 200
|
||||
[source,json]
|
||||
----
|
||||
{
|
||||
"data" : "object",
|
||||
"status" : "string"
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
[[_loginusingpost]]
|
||||
==== 用户登录
|
||||
....
|
||||
@@ -157,7 +294,7 @@ POST /api/user/login
|
||||
|
||||
|
||||
===== 说明
|
||||
传入用户名,以及密码的MD5值,进行登录
|
||||
传入用户名,以及密码明文,后台计算密码SHA1值,进行登录
|
||||
|
||||
|
||||
===== 参数
|
||||
@@ -165,7 +302,7 @@ POST /api/user/login
|
||||
[options="header", cols=".^2a,.^3a,.^4a"]
|
||||
|===
|
||||
|类型|名称|类型
|
||||
|**FormData**|**encryptpwd** +
|
||||
|**FormData**|**password** +
|
||||
__可选__|string
|
||||
|**FormData**|**username** +
|
||||
__可选__|string
|
||||
@@ -222,6 +359,117 @@ __可选__|string
|
||||
----
|
||||
|
||||
|
||||
[[_logoutusingget]]
|
||||
==== 用户登出
|
||||
....
|
||||
GET /api/user/logout
|
||||
....
|
||||
|
||||
|
||||
===== 说明
|
||||
用户退出登录
|
||||
|
||||
|
||||
===== 参数
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
|===
|
||||
|类型|名称|说明|类型
|
||||
|**Query**|**token** +
|
||||
__必填__|token|string
|
||||
|===
|
||||
|
||||
|
||||
===== 响应
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP代码|说明|类型
|
||||
|**200**|OK|<<_commonreturntype,CommonReturnType>>
|
||||
|**401**|Unauthorized|无内容
|
||||
|**403**|Forbidden|无内容
|
||||
|**404**|Not Found|无内容
|
||||
|===
|
||||
|
||||
|
||||
===== 生成
|
||||
|
||||
* `\*/*`
|
||||
|
||||
|
||||
===== HTTP请求示例
|
||||
|
||||
====== 请求 path
|
||||
----
|
||||
/api/user/logout?token=string
|
||||
----
|
||||
|
||||
|
||||
===== HTTP响应示例
|
||||
|
||||
====== 响应 200
|
||||
[source,json]
|
||||
----
|
||||
{
|
||||
"data" : "object",
|
||||
"status" : "string"
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
[[_908e76a1e64eba3a29d68b89ae1eb608]]
|
||||
=== 网站后台状态检测
|
||||
Status Controller
|
||||
|
||||
|
||||
[[_getusingget_2]]
|
||||
==== 系统状态
|
||||
....
|
||||
GET /api/status/get
|
||||
....
|
||||
|
||||
|
||||
===== 说明
|
||||
获取服务器当前系统负载。SystemLoadAverage返回-1时代表不支持。
|
||||
|
||||
|
||||
===== 响应
|
||||
|
||||
[options="header", cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
|HTTP代码|说明|类型
|
||||
|**200**|OK|<<_commonreturntype,CommonReturnType>>
|
||||
|**401**|Unauthorized|无内容
|
||||
|**403**|Forbidden|无内容
|
||||
|**404**|Not Found|无内容
|
||||
|===
|
||||
|
||||
|
||||
===== 生成
|
||||
|
||||
* `\*/*`
|
||||
|
||||
|
||||
===== HTTP请求示例
|
||||
|
||||
====== 请求 path
|
||||
----
|
||||
/api/status/get
|
||||
----
|
||||
|
||||
|
||||
===== HTTP响应示例
|
||||
|
||||
====== 响应 200
|
||||
[source,json]
|
||||
----
|
||||
{
|
||||
"data" : "object",
|
||||
"status" : "string"
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
|
||||
|
||||
[[_definitions]]
|
||||
|
Reference in New Issue
Block a user