SPA项目接口文档

简介: SPA项目接口文档

1.用户相关

1.1.登录

用户登录系统

请求地址

POST http://localhost:8080/ssm/user/userLogin

请求参数

属性 类型 默认值 必填 说明
username String 用户名
password String 密码

返回值

Object

返回的JSON数据

属性 类型 说明
msg String 返回信息
rows array
success Boolean 是否登录成功
total int

请求数据示例

{
    username: admin
  password: 1234
}

返回数据示例

{
  "msg": "用户登陆成功!",
  "success": true,
  "total": 0,
  "rows": null
}

1.2.注册

用户注册

请求地址

POST http://localhost:8080/ssm/user/userRegister

请求参数

属性 类型 默认值 必填 说明
username String 用户名
password String 密码

返回值

Object

返回的JSON数据包

属性 类型 说明
msg String 返回信息
rows array
success Boolean 是否注册成功
total int

请求数据示例

{
    username: admin
  password: 1234
}

返回数据示例

{
  "msg": "用户注册成功!",
  "success": true,
  "total": 0,
  "rows": null
}

2.书籍管理

2.1.查询书籍列表

查询书籍的列表信息

请求地址

GET http://localhost:8080/ssm/book/queryBookPager

请求参数

属性 类型 默认值 必填 说明
bookname String 书籍名
page int 页码数
rows int 每页显示数据条数

返回值

Object

返回的JSON数据包

属性 类型 说明
msg String 返回信息
rows array 数据列表
success Boolean 是否查询成功
total int 总数据条数

请求数据示例

bookname=红楼梦&page=2&rows=20

返回数据示例

{
    "msg": "OK",
    "success": true,
    "total": 34,
    "rows": [
        {
            "id": 51,
            "bookname": "红楼梦",
            "price": 100.0,
            "booktype": "玄幻"
        },
        {
            "id": 50,
            "bookname": "C#",
            "price": 150.0,
            "booktype": "计算机"
        },
        {
            "id": 47,
            "bookname": "假如给我三天光明",
            "price": 100.0,
            "booktype": "散文"
        },
        {
            "id": 46,
            "bookname": "安徒生童话",
            "price": 120.0,
            "booktype": "古典"
        },
        {
            "id": 45,
            "bookname": "三体2",
            "price": 100.0,
            "booktype": "文学"
        },
        {
            "id": 41,
            "bookname": "过把瘾就死",
            "price": 200.0,
            "booktype": "教育"
        },
        {
            "id": 40,
            "bookname": "悟空传1",
            "price": 881.0,
            "booktype": "玄幻"
        },
        {
            "id": 39,
            "bookname": "诡秘之主",
            "price": 100.0,
            "booktype": "玄幻"
        },
        {
            "id": 38,
            "bookname": "黄帝内经",
            "price": 1000.0,
            "booktype": "玄幻"
        },
        {
            "id": 37,
            "bookname": "神秘复苏",
            "price": 60.0,
            "booktype": "悬疑"
        }
    ]
}

2.2.书籍添加

添加书籍信息

请求地址

POST http://localhost:8080/ssm/book/addBook

请求参数

属性 类型 默认值 必填 说明
bookname String 书籍名称
price double 书籍价格
booktype String 书籍种类

返回值

Object

返回的JSON数据包

属性 类型 说明
msg String 返回信息
rows array 数据列表
success Boolean 是否添加成功
total int 总数据条数

请求数据示例

{
    bookname: aa
  price: 12
  booktype: 名著
}

返回数据示例

{
    "msg":"新增书本成功",
    "success":true,
    "total":0,
    "rows":null
}

2.3.书籍修改

修改书籍信息

请求地址

POST http://localhost:8080/ssm/book/editBook

请求参数

属性 类型 默认值 必填 说明
id int 要修改的书籍id
bookname String 书籍名称
price double 书籍价格
booktype String 书籍种类

返回值

Object

返回的JSON数据包

属性 类型 说明
msg String 返回信息
rows array 数据列表
success Boolean 是否修改成功
total int 总数据条数

请求数据示例

{
    id: 58
    bookname: aa
  price: 12
  booktype: 名著
}

返回数据示例

{
    "msg":"编辑书本成功",
    "success":true,
    "total":0,
    "rows":null
}

2.4.书籍删除

删除书籍信息

请求地址

POST http://localhost:8080/ssm/book/delBook

请求参数

属性 类型 默认值 必填 说明
id int 要删除的书籍id

返回值

Object

返回的JSON数据包

属性 类型 说明
msg String 返回信息
rows array 数据列表
success Boolean 是否删除成功
total int 总数据条数

请求数据示例

{
    id: 58
}

返回数据示例

{
    "msg":"删除书本成功",
    "success":true,
    "total":0,
    "rows":null
}

3.菜单模块

3.1.查询首页菜单

查询书籍的列表信息

请求地址

GET http://localhost:8080/ssm/module/queryRootNode

请求参数

返回值

Object

返回的JSON数据包

属性 类型 说明
msg String 返回信息
rows array 数据列表
success Boolean 是否查询成功
total int 总数据条数

请求数据示例

返回数据示例

{
  "msg": "OK",
  "success": true,
  "total": 0,
  "rows": [
    {
      "id": 10,
      "pid": -1,
      "text": "书本管理",
      "icon": "el-icon-notebook-2",
      "url": "",
      "sort": 1,
      "modules": [
        {
          "id": 1001,
          "pid": 10,
          "text": "新增书本",
          "icon": "el-icon-notebook-1",
          "url": "/book/AddBook",
          "sort": 5,
          "modules": []
        },
        {
          "id": 1002,
          "pid": 10,
          "text": "书本管理",
          "icon": "el-icon-document-copy",
          "url": "/book/BookList",
          "sort": 5,
          "modules": []
        }
      ]
    },
    {
      "id": 11,
      "pid": -1,
      "text": "订单管理",
      "icon": "el-icon-s-order",
      "url": "",
      "sort": 2,
      "modules": [
        {
          "id": 1101,
          "pid": 11,
          "text": "订单管理",
          "icon": "",
          "url": "/order/OrderList",
          "sort": 6,
          "modules": []
        },
        {
          "id": 1102,
          "pid": 11,
          "text": "订单统计",
          "icon": null,
          "url": "/OrderStatistics",
          "sort": 7,
          "modules": []
        }
      ]
    }
  ]
}
目录
相关文章
|
7月前
|
前端开发 数据可视化 Java
如何快速搞定在线接口文档
该文介绍了如何高效管理在线接口文档,强调了实时更新接口文档对于前后端并行开发的重要性。文中提到了Swagger,一个用于生成、描述和调用RESTful Web服务的框架,它能自动生成接口文档,促进团队协作,并支持功能测试。Springfox是Spring与Swagger的结合,简化了其在项目中的使用。另外,文章推荐了knife4j,这是一个Java MVC框架的Swagger增强工具,小巧、轻量且功能强大,目前被广泛采用。
118 5
|
7月前
|
API
23_Swagger接口文档
23_Swagger接口文档
74 0
|
API 数据安全/隐私保护 网络架构
接口文档编写规范(前后端分离项目接口api)
接口文档编写规范(前后端分离项目接口api)
565 0
|
安全 数据可视化 Java
Swagger 自动生成 Api 文档:简化接口文档编写
自动生成 API 文档的好处不言而喻,它可以提供给你的团队或者外部协作者,方便 API 使用者准确地调用到你的 API。为了降低手动编写文档带来的错误,很多 API 开发者会偏向于寻找一些好的方法来自动生成 API 文档。
Swagger 自动生成 Api 文档:简化接口文档编写
|
运维 前端开发 JavaScript
Swagger生成接口文档
Swagger生成接口文档
206 0
|
API C#
【C#编程最佳实践 二十三】如何将接口生成接口文档
【C#编程最佳实践 二十三】如何将接口生成接口文档
398 0
【C#编程最佳实践 二十三】如何将接口生成接口文档
|
前端开发 数据可视化 Java
在 SpringBoot 项目中使用 Swagger 接口文档演示
在 SpringBoot 项目中使用 Swagger 接口文档演示
239 0
在 SpringBoot 项目中使用 Swagger 接口文档演示
|
前端开发 搜索推荐 Java
聊聊接口文档的事儿
聊聊接口文档的事儿
239 0
|
消息中间件 JavaScript 小程序
接口文档设计的12个注意点!
接口文档设计的12个注意点!
|
SQL JSON 缓存
接口文档设计的12个注意点! 下
接口文档设计的12个注意点! 下