mirror of
https://gitee.com/bookshelfplus/bookshelfplus
synced 2025-09-04 08:01:39 +08:00
更新Api文档
This commit is contained in:
@@ -36,42 +36,26 @@ __域名__ : localhost:8090
|
||||
Book Controller
|
||||
|
||||
|
||||
[[_addusingget]]
|
||||
==== 【管理员】添加书籍
|
||||
[[_deletebookusingpost]]
|
||||
==== 【管理员】删除书籍
|
||||
....
|
||||
GET /api/book/add
|
||||
POST /api/book/delete
|
||||
....
|
||||
|
||||
|
||||
===== 说明
|
||||
管理员在后台添加书籍
|
||||
管理员在后台删除书籍
|
||||
|
||||
|
||||
===== 参数
|
||||
|
||||
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|
||||
[options="header", cols=".^2a,.^3a,.^4a"]
|
||||
|===
|
||||
|类型|名称|说明|类型
|
||||
|**Query**|**author** +
|
||||
__可选__|author|string
|
||||
|**Query**|**bookName** +
|
||||
__可选__|bookName|string
|
||||
|**Query**|**categoryId** +
|
||||
__可选__|categoryId|integer (int32)
|
||||
|**Query**|**copyright** +
|
||||
__可选__|copyright|string
|
||||
|**Query**|**description** +
|
||||
__可选__|description|string
|
||||
|**Query**|**isDelete** +
|
||||
__可选__|isDelete|boolean
|
||||
|**Query**|**language** +
|
||||
__可选__|language|string
|
||||
|**Query**|**publishingHouse** +
|
||||
__可选__|publishingHouse|string
|
||||
|**Query**|**thumbnail** +
|
||||
__可选__|thumbnail|string
|
||||
|**Query**|**token** +
|
||||
__可选__|token|string
|
||||
|类型|名称|类型
|
||||
|**FormData**|**id** +
|
||||
__可选__|integer (int32)
|
||||
|**FormData**|**token** +
|
||||
__可选__|string
|
||||
|===
|
||||
|
||||
|
||||
@@ -81,12 +65,18 @@ __可选__|token|string
|
||||
|===
|
||||
|HTTP代码|说明|类型
|
||||
|**200**|OK|<<_commonreturntype,CommonReturnType>>
|
||||
|**201**|Created|无内容
|
||||
|**401**|Unauthorized|无内容
|
||||
|**403**|Forbidden|无内容
|
||||
|**404**|Not Found|无内容
|
||||
|===
|
||||
|
||||
|
||||
===== 消耗
|
||||
|
||||
* `application/x-www-form-urlencoded`
|
||||
|
||||
|
||||
===== 生成
|
||||
|
||||
* `\*/*`
|
||||
@@ -96,7 +86,105 @@ __可选__|token|string
|
||||
|
||||
====== 请求 path
|
||||
----
|
||||
/api/book/add
|
||||
/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"
|
||||
----
|
||||
|
||||
|
||||
|
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user