bookshelfplus/bookshelfplus
1
0
Fork 0
mirror of https://gitee.com/bookshelfplus/bookshelfplus synced 2025-10-07 00:15:15 +08:00
Code Issues Projects Releases Wiki Activity GitHub Gitee
Files
7c452b851d451ee900662bebfd49408e0ebc858e
bookshelfplus/bookshelfplus/docs/asciidoc/generated/all.adoc

2109 lines
28 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

= 书栖网 服务端接口文档
[[_overview]]
== 概览
RESTful API | bookshelf.plus
=== 版本信息
[%hardbreaks]
__版本__ : 1.0
=== URI scheme
[%hardbreaks]
__域名__ : localhost:8090
=== 标签
* 书籍信息 : Book Controller
* 书籍分类信息 : Category Controller
* 导出数据 : Export Controller
* 文件管理 : File Controller
* 用户操作 : User Controller
* 第三方登录 : Third Party Controller
* 系统调试接口 : System Controller
* 网站后台状态检测 : Status Controller
[[_paths]]
== 资源
[[_261c63557a0a2affe4e9ee7cf30075c0]]
=== 书籍信息
Book Controller
[[_deletebookusingpost]]
==== 【管理员】删除书籍
....
POST /api/book/delete
....
===== 说明
管理员在后台删除书籍
===== 参数
[options="header", cols=".^2a,.^3a,.^4a"]
|===
|类型|名称|类型
|**FormData**|**id** +
__可选__|integer (int32)
|**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/delete
----
====== 请求 formData
[source,json]
----
"string"
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_detailusingpost]]
==== 【管理员】添加/修改书籍
....
POST /api/book/detail
....
===== 说明
管理员在后台添加/修改书籍（bookId 传 0 或 null 或 不传 即为添加）
===== 参数
[options="header", cols=".^2a,.^3a,.^4a"]
|===
|类型|名称|类型
|**FormData**|**author** +
__可选__|string
|**FormData**|**bookName** +
__可选__|string
|**FormData**|**categoryId** +
__可选__|integer (int32)
|**FormData**|**copyright** +
__可选__|string
|**FormData**|**description** +
__可选__|string
|**FormData**|**id** +
__可选__|integer (int32)
|**FormData**|**isDelete** +
__可选__|boolean
|**FormData**|**language** +
__可选__|string
|**FormData**|**publishingHouse** +
__可选__|string
|**FormData**|**thumbnail** +
__可选__|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/book/detail
----
====== 请求 formData
[source,json]
----
"string"
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_getusingget]]
==== 获取书籍信息
....
GET /api/book/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/book/get?id=0
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_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
....
===== 说明
用户收藏书籍
===== 参数
[options="header", cols=".^2a,.^3a,.^4a"]
|===
|类型|名称|类型
|**FormData**|**bookId** +
__可选__|integer (int32)
|**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/getFavoritesStatus
----
====== 请求 formData
[source,json]
----
"string"
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_searchusingget]]
==== 查询书籍列表
....
GET /api/book/search
....
===== 说明
通过指定条件查询书籍列表
===== 参数
[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
|===
===== 响应
[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP代码|说明|类型
|**200**|OK|<<_commonreturntype,CommonReturnType>>
|**401**|Unauthorized|无内容
|**403**|Forbidden|无内容
|**404**|Not Found|无内容
|===
===== 生成
* `\*/*`
===== HTTP请求示例
====== 请求 path
----
/api/book/search
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_togglefavoritesusingpost]]
==== 【用户】收藏/取消收藏书籍
....
POST /api/book/toggleFavorites
....
===== 说明
用户收藏书籍
===== 参数
[options="header", cols=".^2a,.^3a,.^4a"]
|===
|类型|名称|类型
|**FormData**|**bookId** +
__可选__|integer (int32)
|**FormData**|**status** +
__可选__|boolean
|**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/toggleFavorites
----
====== 请求 formData
[source,json]
----
"string"
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_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"
}
----
[[_getallusingget]]
==== 获取所有分类
....
GET /api/category/list
....
===== 说明
获取所有的书籍分类
===== 响应
[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP代码|说明|类型
|**200**|OK|<<_commonreturntype,CommonReturnType>>
|**401**|Unauthorized|无内容
|**403**|Forbidden|无内容
|**404**|Not Found|无内容
|===
===== 生成
* `\*/*`
===== HTTP请求示例
====== 请求 path
----
/api/category/list
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_631bcafa70826116dc02af62f26b6587]]
=== 导出数据
Export Controller
[[_exportmarkdownusingpost]]
==== 【管理员】导出系统数据
....
POST /api/export/markdown
....
===== 说明
将系统中的所有数据导出为markdown
===== 参数
[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/export/markdown
----
====== 请求 formData
[source,json]
----
"string"
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_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**|**fileExt** +
__可选__||string
|**FormData**|**fileId** +
__可选__||integer (int32)
|**FormData**|**fileName** +
__可选__||string
|**FormData**|**fileNameAndExt** +
__可选__||string
|**FormData**|**fileSha1** +
__可选__||string
|**FormData**|**fileSize** +
__可选__||integer (int64)
|**FormData**|**lastModified** +
__可选__||integer (int64)
|**FormData**|**token** +
__可选__||string
|**FormData**|**visitorId** +
__可选__||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"
}
----
[[_getfileusingget]]
==== 书籍下载页面获取文件提供的下载方式
....
GET /api/file/getFile
....
===== 参数
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|类型|名称|说明|类型
|**Query**|**bookId** +
__可选__|bookId|integer (int32)
|===
===== 响应
[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP代码|说明|类型
|**200**|OK|<<_commonreturntype,CommonReturnType>>
|**401**|Unauthorized|无内容
|**403**|Forbidden|无内容
|**404**|Not Found|无内容
|===
===== 生成
* `\*/*`
===== HTTP请求示例
====== 请求 path
----
/api/file/getFile
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_listusingpost]]
==== 【管理员】查询文件列表
....
POST /api/file/list
....
===== 说明
查询文件列表
===== 参数
[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/file/list
----
====== 请求 formData
[source,json]
----
"string"
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_matchfilehashusingpost]]
==== 【管理员】查询文件列表（匹配文件哈希）
....
POST /api/file/list/MatchfileHash
....
===== 说明
查询文件列表，返回文件哈希为空或者相同的文件
===== 参数
[options="header", cols=".^2a,.^3a,.^4a"]
|===
|类型|名称|类型
|**FormData**|**fileSha1** +
__可选__|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/list/MatchfileHash
----
====== 请求 formData
[source,json]
----
"string"
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_failurefeedbackusingpost]]
==== 链接失效反馈
....
POST /api/file/object/FailureFeedback
....
===== 说明
查询文件列表
===== 参数
[options="header", cols=".^2a,.^3a,.^4a"]
|===
|类型|名称|类型
|**FormData**|**bookId** +
__可选__|integer (int32)
|**FormData**|**fileId** +
__可选__|integer (int32)
|**FormData**|**fileObjectId** +
__可选__|integer (int32)
|**FormData**|**token** +
__可选__|string
|**FormData**|**visitorId** +
__可选__|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/object/FailureFeedback
----
====== 请求 formData
[source,json]
----
"string"
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_objectlistusingpost]]
==== 【管理员】查询文件对象列表
....
POST /api/file/object/list
....
===== 说明
查询文件列表
===== 参数
[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/file/object/list
----
====== 请求 formData
[source,json]
----
"string"
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_refreshfileobjectstatususingpost]]
==== 【管理员】更新文件对象上传状态
....
POST /api/file/object/refreshFileObjectStatus
....
===== 说明
重新从 COS 对象存储中获取文件对象上传状态
===== 参数
[options="header", cols=".^2a,.^3a,.^4a"]
|===
|类型|名称|类型
|**FormData**|**fileObjectId** +
__可选__|integer (int32)
|**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/object/refreshFileObjectStatus
----
====== 请求 formData
[source,json]
----
"string"
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_coscheckfilestatususingpost]]
==== 【COS】腾讯云 COS 文件上传成功回调
....
POST /api/file/upload/cos-check-file-state
....
===== 说明
客户端向腾讯云 COS 存储桶上传文件完毕，有云函数触发此请求
===== 参数
[options="header", cols=".^2a,.^3a,.^4a"]
|===
|类型|名称|类型
|**FormData**|**context** +
__可选__|string
|**FormData**|**event** +
__可选__|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/upload/cos-check-file-state
----
====== 请求 formData
[source,json]
----
"string"
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_9083a36b9e1b060bcb75ff62bb4bda37]]
=== 用户操作
User Controller
[[_cancelaccountusingpost]]
==== 【用户】账号注销
....
POST /api/user/cancelAccount
....
===== 说明
传入用户 token ，以及密码明文，后台计算密码SHA1值，进行注销
===== 参数
[options="header", cols=".^2a,.^3a,.^4a"]
|===
|类型|名称|类型
|**FormData**|**password** +
__可选__|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/user/cancelAccount
----
====== 请求 formData
[source,json]
----
"string"
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_getuserstatususingpost]]
==== 获取用户登录状态
....
POST /api/user/getUserStatus
....
===== 说明
获取用户登录状态
===== 参数
[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/user/getUserStatus
----
====== 请求 formData
[source,json]
----
"string"
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_loginusingpost]]
==== 用户登录
....
POST /api/user/login
....
===== 说明
传入用户名，以及密码明文，后台计算密码SHA1值，进行登录
===== 参数
[options="header", cols=".^2a,.^3a,.^4a"]
|===
|类型|名称|类型
|**FormData**|**password** +
__可选__|string
|**FormData**|**username** +
__可选__|string
|**FormData**|**visitorId** +
__可选__|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/user/login
----
====== 请求 formData
[source,json]
----
"string"
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_logoutusingpost]]
==== 【用户|管理员】用户登出
....
POST /api/user/logout
....
===== 说明
用户退出登录
===== 参数
[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/user/logout
----
====== 请求 formData
[source,json]
----
"string"
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_registerusingpost]]
==== 用户注册
....
POST /api/user/register
....
===== 说明
传入用户名，以及密码明文，后台计算密码SHA1值，进行注册
===== 参数
[options="header", cols=".^2a,.^3a,.^4a"]
|===
|类型|名称|类型
|**FormData**|**password** +
__可选__|string
|**FormData**|**username** +
__可选__|string
|**FormData**|**visitorId** +
__可选__|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/user/register
----
====== 请求 formData
[source,json]
----
"string"
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_4b02b6687df4f15fab50b8d31c1fc123]]
=== 第三方登录
Third Party Controller
[[_callbackusingget]]
==== 快捷登录回调函数
....
GET /api/third-party/callback/{platform}
....
===== 说明
如果传入 token 那么就是绑定第三方账号到当前登录账号，否则就是通过第三方授权登录
===== 参数
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|类型|名称|说明|类型
|**Path**|**platform** +
__必填__|platform|string
|**Query**|**auth_code** +
__可选__||string
|**Query**|**authorization_code** +
__可选__||string
|**Query**|**code** +
__可选__||string
|**Query**|**oauth_token** +
__可选__||string
|**Query**|**oauth_verifier** +
__可选__||string
|**Query**|**state** +
__可选__||string
|**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/third-party/callback/string
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_getbindingstatususingget]]
==== 【用户|管理员】获取用户已绑定的第三方平台
....
GET /api/third-party/getBindingStatus
....
===== 说明
传入当前登录用户 token ，返回已绑定的第三方平台
===== 参数
[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/third-party/getBindingStatus
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_loginusingget]]
==== 第三方用户登录跳转地址
....
GET /api/third-party/login
....
===== 说明
传入需要登录的第三方平台（大小写均可），返回跳转url
===== 参数
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|类型|名称|说明|类型
|**Query**|**platform** +
__必填__|platform|string
|===
===== 响应
[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP代码|说明|类型
|**200**|OK|<<_commonreturntype,CommonReturnType>>
|**401**|Unauthorized|无内容
|**403**|Forbidden|无内容
|**404**|Not Found|无内容
|===
===== 生成
* `\*/*`
===== HTTP请求示例
====== 请求 path
----
/api/third-party/login?platform=string
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_unbindthirdpartaccountusingpost]]
==== 【用户|管理员】取消第三方平台绑定
....
POST /api/third-party/withdrawThirdPartyBings
....
===== 说明
传入当前登录用户 token 和平台 platform （不区分大小写），返回 bool 值，true 为取消绑定成功
===== 参数
[options="header", cols=".^2a,.^3a,.^4a"]
|===
|类型|名称|类型
|**FormData**|**platform** +
__可选__|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/third-party/withdrawThirdPartyBings
----
====== 请求 formData
[source,json]
----
"string"
----
===== HTTP响应示例
====== 响应 200
[source,json]
----
{
"data" : "object",
"status" : "string"
}
----
[[_aca0f16a4237edba915fe70c9b07871c]]
=== 系统调试接口
System Controller
[[_statususingpost]]
==== 【管理员】获取系统配置
....
POST /api/system/status
....
===== 说明
仅限管理员登录状态下可获取
===== 参数
[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/system/status
----
====== 请求 formData
[source,json]
----
"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]]
== 定义
[[_commonreturntype]]
=== CommonReturnType
[options="header", cols=".^3a,.^11a,.^4a"]
|===
|名称|说明|类型
|**data** +
__可选__|**样例** : `"object"`|object
|**status** +
__可选__|**样例** : `"string"`|string
|===
Reference in New Issue View Git Blame Copy Permalink