书栖网服务端接口文档

2.1. 书籍信息

Book Controller

2.1.1. 【管理员】删除书籍

POST /api/book/delete

说明

管理员在后台删除书籍

参数

类型	名称	类型
FormData	id 可选	integer (int32)
FormData	token 可选	string

类型

名称

类型

FormData

id
可选

integer (int32)

FormData

token
可选

string

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/book/delete

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.1.2. 【管理员】添加/修改书籍

POST /api/book/detail

说明

管理员在后台添加/修改书籍（bookId 传 0 或 null 或不传即为添加）

参数

类型	名称	类型
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

类型

名称

类型

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

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/book/detail

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.1.3. 获取书籍信息

GET /api/book/get

说明

获取书籍信息

参数

类型	名称	说明	类型
Query	id 必填	id	integer (int32)

类型

名称

说明

类型

Query

id
必填

id

integer (int32)

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成

*/*

HTTP请求示例

请求 path

/api/book/get?id=0

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.1.4. 【用户】用户收藏书籍列表

POST /api/book/getFavoritesList

说明

获取用户的收藏书籍列表

参数

类型	名称	类型
FormData	token 可选	string

类型

名称

类型

FormData

token
可选

string

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/book/getFavoritesList

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.1.5. 【用户】收藏/取消收藏书籍

POST /api/book/getFavoritesStatus

说明

用户收藏书籍

参数

类型	名称	类型
FormData	bookId 可选	integer (int32)
FormData	token 可选	string

类型

名称

类型

FormData

bookId
可选

integer (int32)

FormData

token
可选

string

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/book/getFavoritesStatus

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.1.6. 查询书籍列表

GET /api/book/search

说明

通过指定条件查询书籍列表

参数

类型	名称	说明	类型
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

类型

名称

说明

类型

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

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成

*/*

HTTP请求示例

请求 path

/api/book/search

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.1.7. 【用户】收藏/取消收藏书籍

POST /api/book/toggleFavorites

说明

用户收藏书籍

参数

类型	名称	类型
FormData	bookId 可选	integer (int32)
FormData	status 可选	boolean
FormData	token 可选	string

类型

名称

类型

FormData

bookId
可选

integer (int32)

FormData

status
可选

boolean

FormData

token
可选

string

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/book/toggleFavorites

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.2. 书籍分类信息

Category Controller

2.2.1. 获取指定分类

GET /api/category/get

说明

获取指定的书籍分类

参数

类型	名称	说明	类型
Query	id 必填	id	integer (int32)

类型

名称

说明

类型

Query

id
必填

id

integer (int32)

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成

*/*

HTTP请求示例

请求 path

/api/category/get?id=0

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.2.2. 获取所有分类

GET /api/category/list

说明

获取所有的书籍分类

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成

*/*

HTTP请求示例

请求 path

/api/category/list

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.3. 导出数据

Export Controller

2.3.1. 【管理员】导出系统数据

POST /api/export/markdown

说明

将系统中的所有数据导出为markdown

参数

类型	名称	类型
FormData	token 可选	string

类型

名称

类型

FormData

token
可选

string

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/export/markdown

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.4. 文件对象管理

File Object Controller

2.4.1. 链接失效反馈

POST /api/file/object/FailureFeedback

说明

查询文件列表

参数

类型	名称	类型
FormData	bookId 可选	integer (int32)
FormData	fileId 可选	integer (int32)
FormData	fileObjectId 可选	integer (int32)
FormData	token 可选	string
FormData	visitorId 可选	string

类型

名称

类型

FormData

bookId
可选

integer (int32)

FormData

fileId
可选

integer (int32)

FormData

fileObjectId
可选

integer (int32)

FormData

token
可选

string

FormData

visitorId
可选

string

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/file/object/FailureFeedback

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.4.2. 【用户|管理员】创建腾讯云 COS 预授权 URL

POST /api/file/object/cos/{httpMethod}

参数

类型	名称	说明	类型
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

类型

名称

说明

类型

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

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/file/object/cos/string

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.4.3. 【管理员】删除文件对象

POST /api/file/object/delete

说明

管理员在后台删除文件对象

参数

类型	名称	类型
FormData	id 可选	integer (int32)
FormData	token 可选	string

类型

名称

类型

FormData

id
可选

integer (int32)

FormData

token
可选

string

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/file/object/delete

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.4.4. 【管理员】添加/修改文件对象

POST /api/file/object/detail

说明

管理员在后台添加/修改文件对象（fileObjectId 传 0 或 null 或不传即为添加）

参数

类型	名称	类型
FormData	fileId 可选	integer (int32)
FormData	filePath 可选	string
FormData	filePwd 可选	string
FormData	fileShareCode 可选	string
FormData	id 可选	integer (int32)
FormData	storageMedium 可选	string
FormData	token 可选	string

类型

名称

类型

FormData

fileId
可选

integer (int32)

FormData

filePath
可选

string

FormData

filePwd
可选

string

FormData

fileShareCode
可选

string

FormData

id
可选

integer (int32)

FormData

storageMedium
可选

string

FormData

token
可选

string

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/file/object/detail

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.4.5. 获取文件对象信息

GET /api/file/object/get

说明

获取文件对象信息

参数

类型	名称	说明	类型
Query	id 必填	id	integer (int32)

类型

名称

说明

类型

Query

id
必填

id

integer (int32)

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成

*/*

HTTP请求示例

请求 path

/api/file/object/get?id=0

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.4.6. 查询指定文件的文件对象列表

GET /api/file/object/getByFileId

说明

传入文件Id，返回文件对象列表

参数

类型	名称	说明	类型
Query	fileId 可选	fileId	integer (int32)

类型

名称

说明

类型

Query

fileId
可选

fileId

integer (int32)

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成

*/*

HTTP请求示例

请求 path

/api/file/object/getByFileId

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.4.7. 【管理员】查询文件对象列表

POST /api/file/object/list

说明

查询文件列表

参数

类型	名称	类型
FormData	token 可选	string

类型

名称

类型

FormData

token
可选

string

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/file/object/list

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.4.8. 【管理员】更新文件对象上传状态

POST /api/file/object/refreshFileObjectStatus

说明

重新从 COS 对象存储中获取文件对象上传状态

参数

类型	名称	类型
FormData	fileObjectId 可选	integer (int32)
FormData	token 可选	string

类型

名称

类型

FormData

fileObjectId
可选

integer (int32)

FormData

token
可选

string

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/file/object/refreshFileObjectStatus

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.4.9. 【COS】腾讯云 COS 文件上传成功回调

POST /api/file/object/upload/cos-check-file-state

说明

客户端向腾讯云 COS 存储桶上传文件完毕，有云函数触发此请求

参数

类型	名称	类型
FormData	context 可选	string
FormData	event 可选	string

类型

名称

类型

FormData

context
可选

string

FormData

event
可选

string

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/file/object/upload/cos-check-file-state

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.5. 文件管理

File Controller

2.5.1. 【管理员】将书籍和文件进行绑定

POST /api/file/bindBook

参数

类型	名称	类型
FormData	bookId 可选	integer (int32)
FormData	fileId 可选	integer (int32)
FormData	token 可选	string

类型

名称

类型

FormData

bookId
可选

integer (int32)

FormData

fileId
可选

integer (int32)

FormData

token
可选

string

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/file/bindBook

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.5.2. 书籍下载页面获取文件提供的下载方式

GET /api/file/getFileByBookId

参数

类型	名称	说明	类型
Query	bookId 必填	bookId	integer (int32)

类型

名称

说明

类型

Query

bookId
必填

bookId

integer (int32)

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成

*/*

HTTP请求示例

请求 path

/api/file/getFileByBookId?bookId=0

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.5.3. 【管理员】通过文件SHA1哈希查找文件Id

POST /api/file/getFileByHash

说明

查询文件列表，返回文件哈希匹配的文件Id

参数

类型	名称	类型
FormData	fileSha1 可选	string
FormData	token 可选	string

类型

名称

类型

FormData

fileSha1
可选

string

FormData

token
可选

string

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/file/getFileByHash

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.5.4. 通过 fileId 获取文件信息

GET /api/file/getFileById

参数

类型	名称	说明	类型
Query	fileId 可选	fileId	integer (int32)

类型

名称

说明

类型

Query

fileId
可选

fileId

integer (int32)

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成

*/*

HTTP请求示例

请求 path

/api/file/getFileById

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.5.5. 【管理员】查询文件列表

POST /api/file/list

说明

查询文件列表

参数

类型	名称	类型
FormData	token 可选	string

类型

名称

类型

FormData

token
可选

string

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/file/list

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.5.6. 【管理员】查询文件列表（匹配文件哈希）

POST /api/file/list/MatchfileHashWithNullValue

说明

查询文件列表，返回文件哈希为空或者相同的文件

参数

类型	名称	类型
FormData	fileSha1 可选	string
FormData	token 可选	string

类型

名称

类型

FormData

fileSha1
可选

string

FormData

token
可选

string

响应

HTTP代码	说明	类型
200	OK	CommonReturnType
201	Created	无内容
401	Unauthorized	无内容
403	Forbidden	无内容
404	Not Found	无内容

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/file/list/MatchfileHashWithNullValue

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.6. 用户操作

User Controller

2.6.1. 【用户】账号注销

POST /api/user/cancelAccount

说明

传入用户 token ，以及密码明文，后台计算密码SHA1值，进行注销

参数

类型	名称	类型
FormData	password 可选	string
FormData	token 可选	string

类型

名称

类型

FormData

password
可选

string

FormData

token
可选

string

响应

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/user/cancelAccount

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.6.2. 获取用户登录状态

POST /api/user/getUserStatus

说明

获取用户登录状态

参数

类型

名称

类型

FormData

token
可选

string

响应

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/user/getUserStatus

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.6.3. 用户登录

POST /api/user/login

说明

传入用户名，以及密码明文，后台计算密码SHA1值，进行登录

参数

类型

名称

类型

FormData

password
可选

string

FormData

username
可选

string

FormData

visitorId
可选

string

响应

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/user/login

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.6.4. 【用户|管理员】用户登出

POST /api/user/logout

说明

用户退出登录

参数

类型

名称

类型

FormData

token
可选

string

响应

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/user/logout

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.6.5. 用户注册

POST /api/user/register

说明

传入用户名，以及密码明文，后台计算密码SHA1值，进行注册

参数

类型

名称

类型

FormData

password
可选

string

FormData

username
可选

string

FormData

visitorId
可选

string

响应

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/user/register

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.7. 第三方登录

Third Party Controller

2.7.1. 快捷登录回调函数

GET /api/third-party/callback/{platform}

说明

如果传入 token 那么就是绑定第三方账号到当前登录账号，否则就是通过第三方授权登录

参数

类型

名称

说明

类型

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

响应

HTTP代码

说明

类型

200

OK

CommonReturnType

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成

*/*

HTTP请求示例

请求 path

/api/third-party/callback/string

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.7.2. 【用户|管理员】获取用户已绑定的第三方平台

GET /api/third-party/getBindingStatus

说明

传入当前登录用户 token ，返回已绑定的第三方平台

参数

类型

名称

说明

类型

Query

token
可选

token

string

响应

HTTP代码

说明

类型

200

OK

CommonReturnType

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成

*/*

HTTP请求示例

请求 path

/api/third-party/getBindingStatus

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.7.3. 第三方用户登录跳转地址

GET /api/third-party/login

说明

传入需要登录的第三方平台（大小写均可），返回跳转url

参数

类型

名称

说明

类型

Query

platform
必填

platform

string

响应

HTTP代码

说明

类型

200

OK

CommonReturnType

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成

*/*

HTTP请求示例

请求 path

/api/third-party/login?platform=string

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.7.4. 【用户|管理员】取消第三方平台绑定

POST /api/third-party/withdrawThirdPartyBings

说明

传入当前登录用户 token 和平台 platform （不区分大小写），返回 bool 值，true 为取消绑定成功

参数

类型

名称

类型

FormData

platform
可选

string

FormData

token
可选

string

响应

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/third-party/withdrawThirdPartyBings

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.8. 系统调试接口

System Controller

2.8.1. 【管理员】获取系统配置

POST /api/system/status

说明

仅限管理员登录状态下可获取

参数

类型

名称

类型

FormData

token
可选

string

响应

HTTP代码

说明

类型

200

OK

CommonReturnType

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗

application/x-www-form-urlencoded

生成

*/*

HTTP请求示例

请求 path

/api/system/status

请求 formData

"string"

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

2.9. 网站后台状态检测

Status Controller

2.9.1. 系统状态

GET /api/status/get

说明

获取服务器当前系统负载。SystemLoadAverage返回-1时代表不支持。

响应

HTTP代码

说明

类型

200

OK

CommonReturnType

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成

*/*

HTTP请求示例

请求 path

/api/status/get

HTTP响应示例

响应 200

{
  "data" : "object",
  "status" : "string"
}

书栖网 服务端接口文档

1. 概览

1.1. 版本信息

1.2. URI scheme

1.3. 标签

2. 资源

2.1. 书籍信息

2.1.1. 【管理员】删除书籍

说明

参数

响应

消耗

生成

HTTP请求示例

请求 path

请求 formData

HTTP响应示例

响应 200

2.1.2. 【管理员】添加/修改书籍

说明

参数

响应

消耗

生成

HTTP请求示例

请求 path

请求 formData

HTTP响应示例

响应 200

2.1.3. 获取书籍信息

说明

参数

响应

生成

HTTP请求示例

请求 path

HTTP响应示例

响应 200

2.1.4. 【用户】用户收藏书籍列表

说明

参数

响应

消耗

生成

HTTP请求示例

请求 path

请求 formData

HTTP响应示例

响应 200

2.1.5. 【用户】收藏/取消收藏书籍

说明

参数

响应

消耗

生成

HTTP请求示例

请求 path

请求 formData

HTTP响应示例

响应 200

2.1.6. 查询书籍列表

说明

参数

响应

生成

HTTP请求示例

请求 path

HTTP响应示例

响应 200

2.1.7. 【用户】收藏/取消收藏书籍

说明

参数

响应

消耗

生成

HTTP请求示例

请求 path

请求 formData

HTTP响应示例

响应 200

书栖网服务端接口文档