mirror of
https://gitee.com/bookshelfplus/bookshelfplus
synced 2025-10-31 02:33:10 +08:00
246 lines
3.0 KiB
Plaintext
246 lines
3.0 KiB
Plaintext
= 书栖网 服务端接口文档
|
||
|
||
|
||
[[_overview]]
|
||
== 概览
|
||
RESTful API | bookshelf.plus
|
||
|
||
|
||
=== 版本信息
|
||
[%hardbreaks]
|
||
__版本__ : 1.0
|
||
|
||
|
||
=== URI scheme
|
||
[%hardbreaks]
|
||
__域名__ : localhost:8090
|
||
|
||
|
||
=== 标签
|
||
|
||
* book-controller : Book Controller
|
||
* status-controller : Status Controller
|
||
* user-controller : User Controller
|
||
|
||
|
||
|
||
|
||
[[_paths]]
|
||
== 资源
|
||
|
||
[[_book-controller_resource]]
|
||
=== Book-controller
|
||
Book Controller
|
||
|
||
|
||
[[_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"
|
||
}
|
||
----
|
||
|
||
|
||
[[_status-controller_resource]]
|
||
=== Status-controller
|
||
Status Controller
|
||
|
||
|
||
[[_getusingget_1]]
|
||
==== 系统状态
|
||
....
|
||
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"
|
||
}
|
||
----
|
||
|
||
|
||
[[_user-controller_resource]]
|
||
=== User-controller
|
||
User Controller
|
||
|
||
|
||
[[_loginusingpost]]
|
||
==== 用户登录
|
||
....
|
||
POST /api/user/login
|
||
....
|
||
|
||
|
||
===== 说明
|
||
传入用户名，以及密码的MD5值，进行登录
|
||
|
||
|
||
===== 参数
|
||
|
||
[options="header", cols=".^2a,.^3a,.^4a"]
|
||
|===
|
||
|类型|名称|类型
|
||
|**FormData**|**encryptpwd** +
|
||
__可选__|string
|
||
|**FormData**|**username** +
|
||
__可选__|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"
|
||
}
|
||
----
|
||
|
||
|
||
|
||
|
||
[[_definitions]]
|
||
== 定义
|
||
|
||
[[_commonreturntype]]
|
||
=== CommonReturnType
|
||
|
||
[options="header", cols=".^3a,.^11a,.^4a"]
|
||
|===
|
||
|名称|说明|类型
|
||
|**data** +
|
||
__可选__|**样例** : `"object"`|object
|
||
|**status** +
|
||
__可选__|**样例** : `"string"`|string
|
||
|===
|
||
|
||
|
||
|
||
|
||
|