一、二手书网站接口文档1. 概述本文档描述了二手书网站系统的所有API接口包括用户管理、书籍管理、购物车、订单管理等核心功能模块。基础信息响应格式JSON字符编码UTF-8基础URLhttp://localhost:80812. 通用响应格式2.1 成功响应{ code: 1, msg: success, data: {} } 2.2 成功响应无数据{ code: 1, msg: success, data: null }2.3 失败响应{ code: 0, msg: 错误描述信息, data: null }2.4 响应字段说明字段类型说明codeInteger响应码1-成功0-失败msgString响应信息描述dataObject返回的数据对象3. 数据模型3.1 书籍对象Book字段类型说明是否必填idInteger书籍ID主键是bookNameString书籍名称是authorString作者是categoryString分类否priceDouble价格是introString简介否3.2 用户对象User字段类型说明是否必填usernameString用户名主键是passwordString密码是genderString性别否ageInteger年龄否hobbyString爱好逗号分隔否3.3 购物车对象Cart字段类型说明是否必填idInteger记录ID主键是usernameString用户名是bookIdInteger书籍ID是numInteger数量是3.4 订单对象Order字段类型说明是否必填orderIdString订单编号主键是usernameString用户名是statusString状态待付款/待发货/待收货/已完成是createTimeDateTime创建时间否4. 页面导航接口4.1 首页接口描述跳转到网站首页项目说明请求URL/index请求方法GET请求参数无4.2 登录页接口描述跳转到用户登录页面项目说明请求URL/login请求方法GET请求参数无4.3 注册页接口描述跳转到用户注册页面项目说明请求URL/zhuce请求方法GET请求参数无5. 用户管理接口5.1 用户登录接口描述用户登录验证项目说明请求URL/loginCheck请求方法GET请求参数Query参数请求参数说明参数名类型必填说明usernameString是用户名passwordString是密码请求示例GET /loginCheck?usernameadminpasswordadmin响应说明登录成功重定向到首页或管理后台登录失败重定向到登录页携带错误信息5.2 用户注册接口描述新用户注册项目说明请求URL/zhuceCheck请求方法GET请求参数Query参数请求参数说明参数名类型必填说明usernameString是用户名唯一passwordString是密码genderString是性别男/女ageInteger否年龄hobbiesString[]否爱好多选请求示例GET /zhuceCheck?usernamezhangsanpassword123456gender男age25hobbies读书hobbies运动5.3 用户退出接口描述用户退出登录项目说明请求URL/logout请求方法GET请求参数无返回结果重定向到首页6. 书籍管理接口6.1 书籍详情页接口描述查看书籍详细信息项目说明请求URL/bookDetail请求方法GET请求参数Query参数请求参数说明参数名类型必填说明nameString否书籍名称为空则跳转首页请求示例GET /bookDetail?name红楼梦6.2 书籍列表管理后台接口描述管理员查看书籍列表支持多条件筛选项目说明请求URL/admin/bookList请求方法GET请求参数Query参数权限要求管理员登录请求参数说明参数名类型必填说明bookNameString否书籍名称模糊查询authorString否作者模糊查询categoryString否分类精确查询minPriceDouble否最低价格maxPriceDouble否最高价格activeString否激活菜单标识请求示例GET /admin/bookList?bookName红楼梦author曹雪芹category文学minPrice20maxPrice506.3 新增书籍页面接口描述跳转到新增书籍页面项目说明请求URL/admin/bookAdd请求方法GET权限要求管理员登录6.4 保存新增书籍接口描述保存新书籍信息项目说明请求URL/admin/bookSave请求方法POST权限要求管理员登录请求参数说明参数名类型必填说明bookNameString是书籍名称authorString是作者categoryString是分类priceDouble是价格introString是简介请求示例POST /admin/bookSave bookName红楼梦author曹雪芹category文学price39.9intro中国古典文学名著7. 购物车接口7.1 购物车页面接口描述查看购物车项目说明请求URL/cart请求方法GET权限要求用户登录7.2 加入购物车通过书籍ID接口描述通过书籍ID将商品加入购物车项目说明请求URL/addCart请求方法GET权限要求用户登录请求参数说明参数名类型必填说明bookIdInteger是书籍IDgotoCheckString否是否跳转结算1是请求示例GET /addCart?bookId1gotoCheck17.3 加入购物车通过书名接口描述通过书名将商品加入购物车书籍详情页专用项目说明请求URL/addCartByName请求方法GET权限要求用户登录请求参数说明参数名类型必填说明nameString是书籍名称gotoCheckString否是否跳转结算1是请求示例GET /addCartByName?name红楼梦gotoCheck17.4 修改购物车数量接口描述修改购物车中商品数量项目说明请求URL/updateCartNum请求方法GET权限要求用户登录请求参数说明参数名类型必填说明cartIdInteger是购物车记录IDnumInteger是新的数量请求示例GET /updateCartNum?cartId5num38. 订单管理接口用户端8.1 订单结算页接口描述进入订单结算页面项目说明请求URL/checkout请求方法GET权限要求用户登录8.2 我的订单列表接口描述查看我的订单列表项目说明请求URL/myOrder请求方法GET权限要求用户登录8.3 订单详情页接口描述查看订单详情项目说明请求URL/orderDetail请求方法GET权限要求用户登录请求参数说明参数名类型必填说明orderIdString否订单编号为空则跳转我的订单请求示例GET /orderDetail?orderIdORD202501010018.4 提交订单接口描述提交订单项目说明请求URL/submitOrder请求方法GET权限要求用户登录8.5 支付订单接口描述用户支付订单项目说明请求URL/payOrder请求方法GET权限要求用户登录请求参数说明参数名类型必填说明orderIdString是订单编号请求示例GET /payOrder?orderIdORD202501010018.6 确认收货接口描述用户确认收货项目说明请求URL/receiveOrder请求方法GET权限要求用户登录请求参数说明参数名类型必填说明orderIdString是订单编号请求示例GET /receiveOrder?orderIdORD202501010018.7 提交评价接口描述对订单商品提交评价项目说明请求URL/submitEvaluate请求方法GET权限要求用户登录请求参数说明参数名类型必填说明itemIdInteger是订单商品项ID请求示例GET /submitEvaluate?itemId1239. 订单管理接口管理员端9.1 待付款订单列表接口描述管理员查看待付款订单项目说明请求URL/admin/order/waitPay请求方法GET权限要求管理员登录9.2 待发货订单列表接口描述管理员查看待发货订单项目说明请求URL/admin/order/waitSend请求方法GET权限要求管理员登录9.3 待收货订单列表接口描述管理员查看待收货订单项目说明请求URL/admin/order/waitReceive请求方法GET权限要求管理员登录9.4 已完成订单列表接口描述管理员查看已完成订单项目说明请求URL/admin/order/finish请求方法GET权限要求管理员登录9.5 管理员发货接口描述管理员将订单状态更新为待收货项目说明请求URL/admin/sendOrder请求方法GET权限要求管理员登录请求参数说明参数名类型必填说明orderIdString是订单编号请求示例GET /admin/sendOrder?orderIdORD2025010100110. 用户管理接口管理员端10.1 用户列表接口描述管理员查看所有注册用户不含管理员项目说明请求URL/admin/userList请求方法GET权限要求管理员登录11. 分类页面接口11.1 分类页面接口描述按分类浏览书籍项目说明请求URL/page1、/page2、/page3、/page4请求方法GET请求参数无12. 错误码说明错误码说明1操作成功0操作失败二、创建数据库表CREATE TABLE book( id INT IDENTITY(1,1) PRIMARY KEY, bookName VARCHAR(50) NOT NULL, author VARCHAR(30) NOT NULL, press VARCHAR(50) NOT NULL, price DECIMAL(5,2) NOT NULL, intro TEXT NULL, imgUrl VARCHAR(255) NULL, category VARCHAR(20) NOT NULL, isHomeShow BIT NOT NULL DEFAULT 0 ); -- 测试插入一条数据 INSERT INTO book(bookName,author,press,price,intro,imgUrl,category,isHomeShow) VALUES(红楼梦,曹雪芹,人民文学出版社,39.90,古典四大名著,1.jpg,文学小说,1);
web应用技术-第8次课后作业
一、二手书网站接口文档1. 概述本文档描述了二手书网站系统的所有API接口包括用户管理、书籍管理、购物车、订单管理等核心功能模块。基础信息响应格式JSON字符编码UTF-8基础URLhttp://localhost:80812. 通用响应格式2.1 成功响应{ code: 1, msg: success, data: {} } 2.2 成功响应无数据{ code: 1, msg: success, data: null }2.3 失败响应{ code: 0, msg: 错误描述信息, data: null }2.4 响应字段说明字段类型说明codeInteger响应码1-成功0-失败msgString响应信息描述dataObject返回的数据对象3. 数据模型3.1 书籍对象Book字段类型说明是否必填idInteger书籍ID主键是bookNameString书籍名称是authorString作者是categoryString分类否priceDouble价格是introString简介否3.2 用户对象User字段类型说明是否必填usernameString用户名主键是passwordString密码是genderString性别否ageInteger年龄否hobbyString爱好逗号分隔否3.3 购物车对象Cart字段类型说明是否必填idInteger记录ID主键是usernameString用户名是bookIdInteger书籍ID是numInteger数量是3.4 订单对象Order字段类型说明是否必填orderIdString订单编号主键是usernameString用户名是statusString状态待付款/待发货/待收货/已完成是createTimeDateTime创建时间否4. 页面导航接口4.1 首页接口描述跳转到网站首页项目说明请求URL/index请求方法GET请求参数无4.2 登录页接口描述跳转到用户登录页面项目说明请求URL/login请求方法GET请求参数无4.3 注册页接口描述跳转到用户注册页面项目说明请求URL/zhuce请求方法GET请求参数无5. 用户管理接口5.1 用户登录接口描述用户登录验证项目说明请求URL/loginCheck请求方法GET请求参数Query参数请求参数说明参数名类型必填说明usernameString是用户名passwordString是密码请求示例GET /loginCheck?usernameadminpasswordadmin响应说明登录成功重定向到首页或管理后台登录失败重定向到登录页携带错误信息5.2 用户注册接口描述新用户注册项目说明请求URL/zhuceCheck请求方法GET请求参数Query参数请求参数说明参数名类型必填说明usernameString是用户名唯一passwordString是密码genderString是性别男/女ageInteger否年龄hobbiesString[]否爱好多选请求示例GET /zhuceCheck?usernamezhangsanpassword123456gender男age25hobbies读书hobbies运动5.3 用户退出接口描述用户退出登录项目说明请求URL/logout请求方法GET请求参数无返回结果重定向到首页6. 书籍管理接口6.1 书籍详情页接口描述查看书籍详细信息项目说明请求URL/bookDetail请求方法GET请求参数Query参数请求参数说明参数名类型必填说明nameString否书籍名称为空则跳转首页请求示例GET /bookDetail?name红楼梦6.2 书籍列表管理后台接口描述管理员查看书籍列表支持多条件筛选项目说明请求URL/admin/bookList请求方法GET请求参数Query参数权限要求管理员登录请求参数说明参数名类型必填说明bookNameString否书籍名称模糊查询authorString否作者模糊查询categoryString否分类精确查询minPriceDouble否最低价格maxPriceDouble否最高价格activeString否激活菜单标识请求示例GET /admin/bookList?bookName红楼梦author曹雪芹category文学minPrice20maxPrice506.3 新增书籍页面接口描述跳转到新增书籍页面项目说明请求URL/admin/bookAdd请求方法GET权限要求管理员登录6.4 保存新增书籍接口描述保存新书籍信息项目说明请求URL/admin/bookSave请求方法POST权限要求管理员登录请求参数说明参数名类型必填说明bookNameString是书籍名称authorString是作者categoryString是分类priceDouble是价格introString是简介请求示例POST /admin/bookSave bookName红楼梦author曹雪芹category文学price39.9intro中国古典文学名著7. 购物车接口7.1 购物车页面接口描述查看购物车项目说明请求URL/cart请求方法GET权限要求用户登录7.2 加入购物车通过书籍ID接口描述通过书籍ID将商品加入购物车项目说明请求URL/addCart请求方法GET权限要求用户登录请求参数说明参数名类型必填说明bookIdInteger是书籍IDgotoCheckString否是否跳转结算1是请求示例GET /addCart?bookId1gotoCheck17.3 加入购物车通过书名接口描述通过书名将商品加入购物车书籍详情页专用项目说明请求URL/addCartByName请求方法GET权限要求用户登录请求参数说明参数名类型必填说明nameString是书籍名称gotoCheckString否是否跳转结算1是请求示例GET /addCartByName?name红楼梦gotoCheck17.4 修改购物车数量接口描述修改购物车中商品数量项目说明请求URL/updateCartNum请求方法GET权限要求用户登录请求参数说明参数名类型必填说明cartIdInteger是购物车记录IDnumInteger是新的数量请求示例GET /updateCartNum?cartId5num38. 订单管理接口用户端8.1 订单结算页接口描述进入订单结算页面项目说明请求URL/checkout请求方法GET权限要求用户登录8.2 我的订单列表接口描述查看我的订单列表项目说明请求URL/myOrder请求方法GET权限要求用户登录8.3 订单详情页接口描述查看订单详情项目说明请求URL/orderDetail请求方法GET权限要求用户登录请求参数说明参数名类型必填说明orderIdString否订单编号为空则跳转我的订单请求示例GET /orderDetail?orderIdORD202501010018.4 提交订单接口描述提交订单项目说明请求URL/submitOrder请求方法GET权限要求用户登录8.5 支付订单接口描述用户支付订单项目说明请求URL/payOrder请求方法GET权限要求用户登录请求参数说明参数名类型必填说明orderIdString是订单编号请求示例GET /payOrder?orderIdORD202501010018.6 确认收货接口描述用户确认收货项目说明请求URL/receiveOrder请求方法GET权限要求用户登录请求参数说明参数名类型必填说明orderIdString是订单编号请求示例GET /receiveOrder?orderIdORD202501010018.7 提交评价接口描述对订单商品提交评价项目说明请求URL/submitEvaluate请求方法GET权限要求用户登录请求参数说明参数名类型必填说明itemIdInteger是订单商品项ID请求示例GET /submitEvaluate?itemId1239. 订单管理接口管理员端9.1 待付款订单列表接口描述管理员查看待付款订单项目说明请求URL/admin/order/waitPay请求方法GET权限要求管理员登录9.2 待发货订单列表接口描述管理员查看待发货订单项目说明请求URL/admin/order/waitSend请求方法GET权限要求管理员登录9.3 待收货订单列表接口描述管理员查看待收货订单项目说明请求URL/admin/order/waitReceive请求方法GET权限要求管理员登录9.4 已完成订单列表接口描述管理员查看已完成订单项目说明请求URL/admin/order/finish请求方法GET权限要求管理员登录9.5 管理员发货接口描述管理员将订单状态更新为待收货项目说明请求URL/admin/sendOrder请求方法GET权限要求管理员登录请求参数说明参数名类型必填说明orderIdString是订单编号请求示例GET /admin/sendOrder?orderIdORD2025010100110. 用户管理接口管理员端10.1 用户列表接口描述管理员查看所有注册用户不含管理员项目说明请求URL/admin/userList请求方法GET权限要求管理员登录11. 分类页面接口11.1 分类页面接口描述按分类浏览书籍项目说明请求URL/page1、/page2、/page3、/page4请求方法GET请求参数无12. 错误码说明错误码说明1操作成功0操作失败二、创建数据库表CREATE TABLE book( id INT IDENTITY(1,1) PRIMARY KEY, bookName VARCHAR(50) NOT NULL, author VARCHAR(30) NOT NULL, press VARCHAR(50) NOT NULL, price DECIMAL(5,2) NOT NULL, intro TEXT NULL, imgUrl VARCHAR(255) NULL, category VARCHAR(20) NOT NULL, isHomeShow BIT NOT NULL DEFAULT 0 ); -- 测试插入一条数据 INSERT INTO book(bookName,author,press,price,intro,imgUrl,category,isHomeShow) VALUES(红楼梦,曹雪芹,人民文学出版社,39.90,古典四大名著,1.jpg,文学小说,1);
