API.md · 陈卓233/bookmg

# Bookmg API规范说明

API分为四类：

1. 登录
2. 管理员
3. 用户
4. Error

## 实体类发送格式

json格式

```json
User类
{
  id:"",
  name:"",
  pwd:"",
  auth:""
}
Book类
{
  bookId: ,
  bookName:"",
  author:"",
  introduction:"",
  reserve: ,
  price:"",
  type:"",
  region:""
}
BorrowList类
{
  id: ,
  userId:"",
  bookId: ,
  bookName:"",
  lendTime:"",
  timeLimit:"",
  backTime:"",
  number: ,
  status:""
}
ReturnList类
{
  id: ,
  userId:"",
  bookId: ,
  bookName:"",
  returnTime:"",
  number: ,
  overdue:"",
  fee:""
}
```

## 登录API

`/login/auth` ：

>用于登录提交表单api
>
>请求方法：post
>
>请求格式：json

json格式规范

```json
{
  id:"",
  password:""
}
```

返回值

```json
成功返回
{
  result:"success"
}
登录失败返回
{
  result:"fail"
}
```

`/login/logout`：

> 用于登录后退出登录
>
> 请求方法：get
>
> 请求格式：无

返回值

```json
成功返回
{
  result:"success"
}
登录失败返回
{
  result:"fail"
}
```

## 管理员API

`/admin/userlist`:

>用于获取全部用户信息
>
>请求方法：get
>
>请求格式：无

返回值

```json
成功返回用户列表
失败无返回后端异常
```

`/admin/selectuser`:

>用于按userId查找用户
>
>请求方法：post
>
>请求格式：json

{userId:""}

返回值

```json
成功返回user
失败无返回
```

`/admin/adduser`:

>用于添加用户
>
>请求方法：post
>
>请求格式: User类

返回值

```json
成功返回success
失败返回fail
```

`/admin/deleteuser`:

>用于删除用户
>
>请求方法：post
>
>请求格式: json

格式

{userId:""}

返回值

```json
成功返回success
失败返回fail
```

`/admin/updateuser`:

>用于修改用户信息
>
>请求方法：post
>
>请求格式: User类

返回值

```json
成功返回success
失败返回fail
```

`/admin/addbook`:

>用于添加书
>
>请求方法：post
>
>请求格式: Book类

返回值

```json
成功返回success
失败返回fail
```

`/admin/deletebook`:

>用于删除书
>
>请求方法：post
>
>请求格式: json

格式

{bookId: }

返回值

```json
成功返回success
失败返回fail
```

`/admin/updatebook`:

>用于修改图书信息
>
>请求方法：post
>
>请求格式: Book类

返回值

```json
成功返回success
失败返回fail
```

`/admin/borrowlist`:

>用于获取全部借书列表
>
>请求方法：get
>
>请求格式: 无

返回值

```json
成功返回list
失败返回无
```

`/admin/borrowbyid`:

>用于按id查询借书记录
>
>请求方法：post
>
>请求格式: json

格式

{userId:""}

返回值

```json
成功返回list
失败返回无
```

`/admin/returnlist`:

>用于获取全部还书记录
>
>请求方法：get
>
>请求格式: 无

返回值

```json
成功返回list
失败返回无
```

`/admin/returnbyuserid`:

>用于按用户id查找还书记录
>
>请求方法：post
>
>请求格式: json

格式

{userId:""}

返回值

```json
成功返回list
失败返回无
```

`/admin/returnbybookid`:

>用于按书编号查找还书记录
>
>请求方法：post
>
>请求格式: json

格式

{bookId: }

返回值

```json
成功返回list
失败返回无
```

## 工作人员API

`/work/borrowlist`:

>用于获取全部借书列表
>
>请求方法：get
>
>请求格式: 无

返回值

```json
成功返回list
失败返回无
```

`/work/borrowbyid`:

>用于按id查询借书记录
>
>请求方法：post
>
>请求格式: json

格式

{userId:""}

返回值

```json
成功返回list
失败返回无
```

`/work/addborrow`:

>用于添加借书信息
>
>请求方法：post
>
>请求格式: BorrowList类

返回值

```json
成功返回success
失败返回fail
```

`/work/deleteborrow`:

>用于删除借书信息
>
>请求方法：post
>
>请求格式: json

格式

{bookId: }

返回值

```json
成功返回success
失败返回fail
```

`/work/updateborrow`:

>用于修改借书信息
>
>请求方法：post
>
>请求格式: BorrowList类

返回值

```json
成功返回success
失败返回fail
```

`/work/returnlist`:

>用于获取全部还书记录
>
>请求方法：get
>
>请求格式: 无

返回值

```json
成功返回list
失败返回无
```

`/work/returnbyuserid`:

>用于按用户id查找还书记录
>
>请求方法：post
>
>请求格式: json

格式

{userId:""}

返回值

```json
成功返回list
失败返回无
```

`/work/returnbybookid`:

>用于按书编号查找还书记录
>
>请求方法：post
>
>请求格式: json

格式

{bookId: }

返回值

```json
成功返回list
失败返回无
```

`/work/addreturn`:

>用于添加还书记录
>
>请求方法：post
>
>请求格式: ReturnList类

返回值

```json
成功返回success
失败返回fail
```

`/work/deletereturn`:

>用于按记录编号删除还书记录
>
>请求方法：post
>
>请求格式: json

{returnId: }

返回值

```json
成功返回success
失败返回fail
```

`/work/updatereturn`:

>用于修改还书记录
>
>请求方法：post
>
>请求格式: ReturnList类

返回值

```json
成功返回success
失败返回fail
```

## 用户API

`/user/booklist`:

>用于获取全部书列表
>
>请求方法：get
>
>请求格式: 无

返回值

```json
成功返回list
失败返回无
```

`/user/findBookId`:

>用于按书编号查找书
>
>请求方法：post
>
>请求格式: json

格式

{bookId: }

返回值

```json
成功返回Book
失败返回无
```

`/user/findBookName`:

>用于书名模糊查询
>
>请求方法：post
>
>请求格式: json

格式

{bookName:""}

返回值

```json
成功返回list
失败返回无
```

`/user/findBookAuthor`:

>用于按书作者查找图书
>
>请求方法：post
>
>请求格式: json

格式

{bookAuthor: ""}

返回值

```json
成功返回list
失败返回无
```

`/user/addBorrow`:

>用于借阅书籍
>
>请求方法：post
>
>请求格式: BorrowList类

返回值

```json
成功返回success
失败返回fail
```

`/user/history`:

>用于查看借阅历史
>
>请求方法：post
>
>请求格式: json

格式

{userId:"''}

返回值

```json
成功返回list
失败返回无
```

`/user/return`:

>用于还书
>
>请求方法：post
>
>请求格式: ReturnList类

返回值

```json
成功返回success
失败返回fail
```

`/user/returnMsg`:

>用于查看还书记录
>
>请求方法：post
>
>请求格式: json

格式

{userId:""}

返回值

```json
成功返回list
失败返回无
```

`/user/myself`:

>用于查看自己信息
>
>请求方法：post
>
>请求格式: json

格式

{userId:""}

返回值

```json
成功返回User
失败返回无
```

`/user/updateMsg`:

>用于修改个人信息，不能改账号
>
>请求方法：post
>
>请求格式: User类

返回值

```json
成功返回success
失败返回fail
```

## Error

`/login`:

>用于没有登录会强行跳转到这个页面
>
>请求方法：get
>
>请求格式: 无

返回值

```json
返回str："假装是登录页面"
```

`/unauthor`:

>用于权限拦截
>
>请求方法：get
>
>请求格式: 无

返回值

```json
返回str："你没有权限"
```

陈卓233/bookmg

简介

发行版

贡献者

近期动态