1. 概览

RESTful API | bookshelf.plus

1.1. 版本信息

版本 : 1.0

1.2. URI scheme

域名 : localhost:8090
基础路径 : /api

1.3. 标签

  • book-controller : Book Controller

  • status-controller : Status Controller

  • user-controller : User Controller

2. 资源

2.1. Book-controller

Book Controller

2.1.1. 获取书籍信息

GET /book/get
说明

获取书籍信息

参数
类型 名称 说明 类型

Query

id
必填

id

integer (int32)
响应
HTTP代码 说明 类型

200

OK

BookVO

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • /

HTTP请求示例
请求 path
/book/get
请求 query
{
  "id" : 0
}
HTTP响应示例
响应 200
{
  "author" : "string",
  "bookName" : "string",
  "category" : {
    "description" : "string",
    "id" : 0,
    "isShow" : true,
    "level" : 0,
    "name" : "string",
    "order" : 0,
    "parentId" : 0
  },
  "copyright" : "string",
  "description" : "string",
  "id" : 0,
  "language" : "string",
  "publishingHouse" : "string",
  "thumbnail" : "string"
}

2.2. Status-controller

Status Controller

2.2.1. 系统负载

GET /status/getSystemLoadAverage
说明

获取服务器当前系统负载。

响应
HTTP代码 说明 类型

200

OK

object

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
生成

  • /

HTTP请求示例
请求 path
/status/getSystemLoadAverage
HTTP响应示例
响应 200
"object"

2.3. User-controller

User Controller

2.3.1. 用户登录

POST /user/login
说明

传入用户名，以及密码的MD5值，进行登录

参数
类型 名称 说明 类型

FormData

encryptpwd
必填

encryptpwd

string

FormData

username
必填

username

string
响应
HTTP代码 说明 类型

200

OK

UserVO

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容
消耗

  • application/x-www-form-urlencoded

生成

  • /

HTTP请求示例
请求 path
/user/login
请求 formData
"string"
HTTP响应示例
响应 200
{
  "avatar" : "string",
  "id" : 0,
  "nickname" : "string",
  "phone" : "string",
  "userIdentity" : "string",
  "username" : "string"
}

3. 定义

3.1. BookVO

名称 说明 类型

author
可选

样例 : "string"

string

bookName
可选

样例 : "string"

string

category
可选

样例 : "CategoryModel"

CategoryModel

copyright
可选

样例 : "string"

string

description
可选

样例 : "string"

string

id
可选

样例 : 0

integer (int32)

language
可选

样例 : "string"

enum (SIMPLIFIED_CHINESE, ENGLISH, TRADITIONAL_CHINESE)

publishingHouse
可选

样例 : "string"

string

thumbnail
可选

样例 : "string"

string

3.2. CategoryModel

名称 说明 类型

description
可选

样例 : "string"

string

id
可选

样例 : 0

integer (int32)

isShow
可选

样例 : true

boolean

level
可选

样例 : 0

integer (int32)

name
可选

样例 : "string"

string

order
可选

样例 : 0

integer (int32)

parentId
可选

样例 : 0

integer (int32)

3.3. UserVO

名称 说明 类型

avatar
可选

样例 : "string"

string

id
可选

样例 : 0

integer (int32)

nickname
可选

样例 : "string"

string

phone
可选

样例 : "string"

string

userIdentity
可选

样例 : "string"

string

username
可选

样例 : "string"

string