POST /api/book/getFavoritesStatus+
POST /api/book/getFavoritesList
+ 查看后端项目配置是否配置正确 +
++ 请按 F12 查看详情 +
+ \ No newline at end of file diff --git a/bookshelfplus/docs/asciidoc/generated/all.adoc b/bookshelfplus/docs/asciidoc/generated/all.adoc index 92e074e..e419b23 100644 --- a/bookshelfplus/docs/asciidoc/generated/all.adoc +++ b/bookshelfplus/docs/asciidoc/generated/all.adoc @@ -20,6 +20,7 @@ __域名__ : localhost:8090 * 书籍信息 : Book Controller * 书籍分类信息 : Category Controller +* 文件管理 : File Controller * 用户操作 : User Controller * 第三方登录 : Third Party Controller * 系统调试接口 : Debug Controller @@ -258,7 +259,78 @@ __必填__|id|integer (int32) ---- -[[_addfavoritesusingpost_1]] +[[_getfavoriteslistusingpost]] +==== 【用户】用户收藏书籍列表 +.... +POST /api/book/getFavoritesList +.... + + +===== 说明 +获取用户的收藏书籍列表 + + +===== 参数 + +[options="header", cols=".^2a,.^3a,.^4a"] +|=== +|类型|名称|类型 +|**FormData**|**token** + +__可选__|string +|=== + + +===== 响应 + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP代码|说明|类型 +|**200**|OK|<<_commonreturntype,CommonReturnType>> +|**201**|Created|无内容 +|**401**|Unauthorized|无内容 +|**403**|Forbidden|无内容 +|**404**|Not Found|无内容 +|=== + + +===== 消耗 + +* `application/x-www-form-urlencoded` + + +===== 生成 + +* `\*/*` + + +===== HTTP请求示例 + +====== 请求 path +---- +/api/book/getFavoritesList +---- + + +====== 请求 formData +[source,json] +---- +"string" +---- + + +===== HTTP响应示例 + +====== 响应 200 +[source,json] +---- +{ + "data" : "object", + "status" : "string" +} +---- + + +[[_getfavoritesstatususingpost]] ==== 【用户】收藏/取消收藏书籍 .... POST /api/book/getFavoritesStatus @@ -399,7 +471,7 @@ __可选__|publishingHouse|string ---- -[[_addfavoritesusingpost]] +[[_togglefavoritesusingpost]] ==== 【用户】收藏/取消收藏书籍 .... POST /api/book/toggleFavorites @@ -585,6 +657,200 @@ GET /api/category/list ---- +[[_5505c91c7c23d55a117904f2a3fe6081]] +=== 文件管理 +File Controller + + +[[_cosusingpost]] +==== 创建腾讯云 COS 预授权 URL +.... +POST /api/file/cos/{httpMethod} +.... + + +===== 参数 + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|类型|名称|说明|类型 +|**Path**|**httpMethod** + +__必填__|httpMethod|string +|**FormData**|**expireMinute** + +__可选__||integer (int32) +|**FormData**|**fileName** + +__可选__||string +|**FormData**|**token** + +__可选__||string +|=== + + +===== 响应 + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP代码|说明|类型 +|**200**|OK|<<_commonreturntype,CommonReturnType>> +|**201**|Created|无内容 +|**401**|Unauthorized|无内容 +|**403**|Forbidden|无内容 +|**404**|Not Found|无内容 +|=== + + +===== 消耗 + +* `application/x-www-form-urlencoded` + + +===== 生成 + +* `\*/*` + + +===== HTTP请求示例 + +====== 请求 path +---- +/api/file/cos/string +---- + + +====== 请求 formData +[source,json] +---- +"string" +---- + + +===== HTTP响应示例 + +====== 响应 200 +[source,json] +---- +{ + "data" : "object", + "status" : "string" +} +---- + + +[[_listusingget]] +==== 查询文件列表 +.... +GET /api/file/list +.... + + +===== 说明 +查询文件列表 + + +===== 参数 + +[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/file/list +---- + + +===== HTTP响应示例 + +====== 响应 200 +[source,json] +---- +{ + "data" : "object", + "status" : "string" +} +---- + + +[[_objectlistusingget]] +==== 查询文件对象列表 +.... +GET /api/file/object/list +.... + + +===== 说明 +查询文件列表 + + +===== 参数 + +[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/file/object/list +---- + + +===== HTTP响应示例 + +====== 响应 200 +[source,json] +---- +{ + "data" : "object", + "status" : "string" +} +---- + + [[_9083a36b9e1b060bcb75ff62bb4bda37]] === 用户操作 User Controller diff --git a/bookshelfplus/docs/asciidoc/html/all.html b/bookshelfplus/docs/asciidoc/html/all.html index b4ffb4e..dd3de27 100644 --- a/bookshelfplus/docs/asciidoc/html/all.html +++ b/bookshelfplus/docs/asciidoc/html/all.html @@ -533,10 +533,11 @@ table.CodeRay td.code>pre{padding:0}书籍分类信息 : Category Controller
文件管理 : File Controller
+用户操作 : User Controller
POST /api/book/getFavoritesStatus+
POST /api/book/getFavoritesList
用户收藏书籍
+获取用户的收藏书籍列表
FormData
bookId
-可选
integer (int32)
-FormData
-token
可选
/api/book/getFavoritesStatus+
/api/book/getFavoritesList
POST /api/book/getFavoritesStatus+
用户收藏书籍
+| 类型 | +名称 | +类型 | +
|---|---|---|
+ FormData + |
+
+ bookId |
+
+ integer (int32) + |
+
+ FormData + |
+
+ token |
+
+ string + |
+
| HTTP代码 | +说明 | +类型 | +
|---|---|---|
+ 200 + |
+
+ OK + |
++ |
+ 201 + |
+
+ Created + |
+
+ 无内容 + |
+
+ 401 + |
+
+ Unauthorized + |
+
+ 无内容 + |
+
+ 403 + |
+
+ Forbidden + |
+
+ 无内容 + |
+
+ 404 + |
+
+ Not Found + |
+
+ 无内容 + |
+
application/x-www-form-urlencoded
*/*
/api/book/getFavoritesStatus+
"string"{
+ "data" : "object",
+ "status" : "string"
+}GET /api/book/search
通过指定条件查询书籍列表
/api/book/search@@ -1618,9 +1794,9 @@ table.CodeRay td.code>pre{padding:0}
{
@@ -1633,20 +1809,20 @@ table.CodeRay td.code>pre{padding:0}
POST /api/book/toggleFavorites
用户收藏书籍
| HTTP代码 | -说明 | -类型 | -
|---|---|---|
- 200 - |
-
- OK - |
-- |
- 201 - |
-
- Created - |
-
- 无内容 - |
-
- 401 - |
-
- Unauthorized - |
-
- 无内容 - |
-
- 403 - |
-
- Forbidden - |
-
- 无内容 - |
-
- 404 - |
-
- Not Found - |
-
- 无内容 - |
-
application/x-www-form-urlencoded
*/*
/api/book/toggleFavorites-
"string"{
- "data" : "object",
- "status" : "string"
-}Category Controller
-GET /api/category/get-
获取指定的书籍分类
-| 类型 | -名称 | -说明 | -类型 | -
|---|---|---|---|
- Query - |
-
- id |
-
- id - |
-
- integer (int32) - |
-
- 401 - |
-
- Unauthorized - |
-
- 无内容 - |
-
- 403 - |
-
- Forbidden - |
-
- 无内容 - |
-
- 404 - |
-
- Not Found - |
-
- 无内容 - |
-
*/*
/api/category/get?id=0-
{
- "data" : "object",
- "status" : "string"
-}GET /api/category/list-
获取所有的书籍分类
-| HTTP代码 | -说明 | -类型 | -
|---|---|---|
- 200 - |
-
- OK - |
-- |
- 401 - |
-
- Unauthorized - |
-
- 无内容 - |
-
- 403 - |
-
- Forbidden - |
-
- 无内容 - |
-
- 404 - |
-
- Not Found - |
-
- 无内容 - |
-
*/*
/api/category/list-
{
- "data" : "object",
- "status" : "string"
-}User Controller
-POST /api/user/cancelAccount-
传入用户 token ，以及密码明文，后台计算密码SHA1值，进行注销
-| 类型 | -名称 | -类型 | -
|---|---|---|
- FormData - |
-
- password |
-
- string - |
-
- FormData - |
-
- token |
-
- string - |
-
| HTTP代码 | -说明 | -类型 | -|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
- 200 - |
-
- OK - |
-- | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
201 |
@@ -2241,6 +1961,280 @@ table.CodeRay td.code>pre{padding:0}
+
+生成+
+
+
+
+HTTP请求示例+
+
+请求 path+
+
+
+
+/api/book/toggleFavorites+
+
+请求 formData+
+
+
+
+
+
+
+
+HTTP响应示例+
+
+响应 200+
+
+
+
+
+
+
+2.2. 书籍分类信息+
+
+Category Controller +
+
+2.2.1. 获取指定分类+
+
+
+
+GET /api/category/get+
+
+说明+
+
+获取指定的书籍分类 +
+
+参数+
+
+响应+
+
+生成+
+
+
+
+HTTP请求示例+
+
+请求 path+
+
+
+
+/api/category/get?id=0+
+
+HTTP响应示例+
+
+响应 200+
+
+
+
+
+
2.2.2. 获取所有分类+
+
+
+
+GET /api/category/list+
+
+说明+
+
+获取所有的书籍分类 +
+
+响应+
生成
请求 path
-
-/api/user/cancelAccount-
-
@@ -2284,43 +2270,87 @@ table.CodeRay td.code>pre{padding:0}
请求 formData-
-
-
/api/category/list
+ 2.3. 文件管理+
+
File Controller +
- 2.3.2. 获取用户登录状态+2.3.1. 创建腾讯云 COS 预授权 URL
-
-POST /api/user/getUserStatus-
-
说明-
-
获取用户登录状态 +POST /api/file/cos/{httpMethod}
参数
-
-消耗-
-
-
生成
请求 path
-
-/api/user/login-
-
@@ -2641,43 +2635,48 @@ table.CodeRay td.code>pre{padding:0}
请求 formData-
-
-
/api/file/list
-
+
+2.3.4. 用户登出+2.3.3. 查询文件对象列表
-
POST /api/user/logout+ GET /api/file/object/list
-
说明+说明
-
用户退出登录 +查询文件列表 参数
-
-消耗-
-
-
生成
请求 path
-
-/api/user/logout-
-
@@ -2812,17 +2782,23 @@ table.CodeRay td.code>pre{padding:0}
请求 formData-
-
-
/api/file/object/list
+ 2.4. 用户操作+
+
User Controller +
-
2.3.5. 用户注册+2.4.1. 账号注销
-
POST /api/user/register+ POST /api/user/cancelAccount
-
说明+说明
-
传入用户名，以及密码明文，后台计算密码SHA1值，进行注册 +传入用户 token ，以及密码明文，后台计算密码SHA1值，进行注销
@@ -2858,7 +2834,7 @@ table.CodeRay td.code>pre{padding:0}
FormData
- username token
@@ -2943,7 +2919,7 @@ table.CodeRay td.code>pre{padding:0}
-
消耗+消耗
-
+请求 formData+请求 formData
+
+2.4.2. 获取用户登录状态+
+
+
+
+POST /api/user/getUserStatus+
+
+说明+
+
+获取用户登录状态 +
+
+参数+
+
+响应+
+
+消耗+
+
+
+
+生成+
+
+
+
+HTTP请求示例+
+
+请求 path+
+
+
+
+/api/user/getUserStatus+
+
+请求 formData+
+
+
+
+
+
+HTTP响应示例+
+
+响应 200+
+
+
+
+
+
+2.4.3. 用户登录+
+
+
+
+POST /api/user/login+
+
+说明+
+
+传入用户名，以及密码明文，后台计算密码SHA1值，进行登录 +
+
+参数+
+
+响应+
+
+消耗+
+
+
+
+生成+
+
+
+
+HTTP请求示例+
+
+请求 path+
+
+
+
+/api/user/login+
+
+请求 formData+
+
+
+
+
+
+HTTP响应示例+
+
+响应 200+
+
+
+
+
+
+2.4.4. 用户登出+
+
+
+
+POST /api/user/logout+
+
+说明+
+
+用户退出登录 +
+
+参数+
+
+响应+
+
+消耗+
+
+
+
+生成+
+
+
+
+HTTP请求示例+
+
+请求 path+
+
+
+
+/api/user/logout+
+
+请求 formData+
+
+
+
+
+
+HTTP响应示例+
+
+响应 200+
+
+
+
+
+
2.4.5. 用户注册+
+
+
+
+POST /api/user/register+
+
+说明+
+
+传入用户名，以及密码明文，后台计算密码SHA1值，进行注册 +
+
+参数+
+
+响应+
+
+消耗+
+
+
+
+生成+
+
+
+
+HTTP请求示例+
+
+请求 path+
+
+
+
+/api/user/register+
+
+请求 formData+
+
+
+
+
+
+HTTP响应示例+
+
+响应 200+
+
+
+
+
- 2.4. 第三方登录+2.5. 第三方登录Third Party Controller
- 2.4.1. 快捷登录回调函数+2.5.1. 快捷登录回调函数GET /api/third-party/callback/{platform}
-
说明+说明如果传入 token 那么就是绑定第三方账号到当前登录账号，否则就是通过第三方授权登录
-
参数+参数
-
响应+响应
-
生成+生成
- HTTP请求示例+HTTP请求示例
- 请求 path+请求 path/api/third-party/callback/string@@ -3229,9 +3917,9 @@ table.CodeRay td.code>pre{padding:0}
- HTTP响应示例+HTTP响应示例
-
-响应 200+响应 200
-
-2.4.2. 获取用户已绑定的第三方平台+2.5.2. 获取用户已绑定的第三方平台GET /api/third-party/getBindingStatus
-
说明+说明传入当前登录用户 token ，返回已绑定的第三方平台
-
参数+参数
-
-响应-
-
-生成-
-
-
-
-HTTP请求示例-
-
-请求 path-
-
-
-
-/api/third-party/getBindingStatus-
-
-HTTP响应示例-
-
-响应 200-
-
-
-
-
-
-2.4.3. 第三方用户登录跳转地址-
-
-
-
-GET /api/third-party/login-
-
-说明-
-
-传入需要登录的第三方平台（大小写均可），返回跳转url -
-
-参数-
-
-响应-
-
-生成-
-
-
-
-HTTP请求示例-
-
-请求 path-
-
-
-
-/api/third-party/login?platform=string-
-
-HTTP响应示例-
-
-响应 200-
-
-
-
-
-
-2.4.4. 取消第三方平台绑定-
-
-
-
-POST /api/third-party/withdrawThirdPartyBings-
-
-说明-
-
-传入当前登录用户 token 和平台 platform （不区分大小写），返回 bool 值，true 为取消绑定成功 -
-
-参数-
-
-响应-
-
-消耗-
-
-
-
-生成-
-
-
-
-HTTP请求示例-
-
-请求 path-
-
-
-
-/api/third-party/withdrawThirdPartyBings-
-
-请求 formData-
-
-
-
-
-
-HTTP响应示例-
-
-响应 200-
-
-
-
-
-
-2.5. 系统调试接口-
-
-Debug Controller -
-
-2.5.1. 获取系统配置-
-
-
-
-POST /api/debug/status-
-
-说明-
-
-仅限管理员登录状态下可获取 -
-
-参数-
-
-响应-
-
-消耗-
-
-
-
-生成-
-
-
-
-HTTP请求示例-
-
-请求 path-
-
-
-
-/api/debug/status-
-
-请求 formData-
-
-
-
-
-
-HTTP响应示例-
-
-响应 200-
-
-
-
-
- 2.6. 网站后台状态检测-
-
-Status Controller -
- 2.6.1. 系统状态-
-
-
-
-GET /api/status/get-
-
-说明-
-
-获取服务器当前系统负载。SystemLoadAverage返回-1时代表不支持。 -响应
+
+响应+
+
+生成+
+
+
+
+HTTP请求示例+
+
+请求 path+
+
+
+
+/api/third-party/login?platform=string+
+
+HTTP响应示例+
+
+响应 200+
+
+
+
+
+
+
+2.5.4. 取消第三方平台绑定+
+
+
+
+POST /api/third-party/withdrawThirdPartyBings+
+
+说明+
+
+传入当前登录用户 token 和平台 platform （不区分大小写），返回 bool 值，true 为取消绑定成功 +
+
+参数+
+
+响应+
+
+消耗+
+
+
+
+生成+
+
+
+
+HTTP请求示例+
+
+请求 path+
+
+
+
+/api/third-party/withdrawThirdPartyBings+
+
+请求 formData+
+
+
+
+
+
+HTTP响应示例+
+
+响应 200+
+
+
+
+
+
+2.6. 系统调试接口+
+
+Debug Controller +
+
+2.6.1. 获取系统配置+
+
+
+
+POST /api/debug/status+
+
+说明+
+
+仅限管理员登录状态下可获取 +
+
+参数+
+
+响应+
+
+消耗+
+
+
+
+生成+
+
+
+
+HTTP请求示例+
+
+请求 path+
+
+
+
+/api/debug/status+
+
+请求 formData+
+
+
+
+
+
+HTTP响应示例+
+
+响应 200+
+
+
+
+
+
@@ -4073,7 +4761,7 @@ table.CodeRay td.code>pre{padding:0}
2.7. 网站后台状态检测+
+
+Status Controller +
+
2.7.1. 系统状态+
+
+
+
+GET /api/status/get+
+
+说明+
+
+获取服务器当前系统负载。SystemLoadAverage返回-1时代表不支持。 +
+
+响应+
+
+生成+
+
+
+
+HTTP请求示例+
+
+请求 path+
+
+
+
+/api/status/get+
+
+HTTP响应示例+
+
+响应 200+
+
+
+
+ |