WEB应用技术第八次作业

编写接口文档确定需求)建数据库表pom.xml 导入项目依赖application.properties配置文件pojo 实体类对应数据库字段util Result 统一返回工具类mapper和 MySQL 数据库交互只写 SQL语句// 在启动类添加全局扫描注解所有 mapper 包下接口自动识别不用给每个接口加Mapper MapperScan(com.example.myweb.mapper)service业务层接口 实现类接口定义对外提供的功能的方法实现类所有判断、校验、规则全写在这里controller控制层接口入口Apifox 测试所有接口一、接口文档1. 概述本文档描述校园二手交易系统用户信息管理相关 API包含登录、分页查询、根据 ID 查询、新增、编辑、删除用户功能。 基础信息响应格式JSON字符编码UTF-82. 通用响应格式2.1 成功响应含数据{ code: 1, msg: success, data: {} }2.2 成功响应但无数据{ code: 0, msg: success, data:null }2.3响应失败{ code: 0, msg: error, data: null }2.4 响应字段说明字段类型说明codeInteger响应码1 成功0 失败msgString操作提示文本dataObject业务数据无数据时为 null3.数据模型3.1用户对象User字段类型说明是否必填uidInteger用户主键 ID是usernameString登录用户名是passwordString登录密码是collegeString所属学院否classNameString班级名称否phoneString联系手机号否dormString宿舍号否roleInteger用户角色0 普通学生1 管理员是addressString宿舍详细地址否createTimeDate创建时间自动填充updateTimeDate更新时间自动填充4.API接口清单4.1用户登录接口多表多环境用户环境http://localhost:8080/user接口描述校验用户名密码登录成功返回用户信息项目内容请求 URL/login请求方式POST请求参数JSON 请求体请求体示例{ username:stu001, password:123456 }成功响应示例{ code: 200, msg: 操作成功, data: { uid: 2, username: stu001, password: 123456, phone: 13800138000, college: 管理学院, className: 信管2402, dorm: 南九-545, role: 0, createTime: 2026-06-24 16:22:55, updateTime: 2026-06-24 16:22:55 } }失败响应示例{ code: 0, msg: error, data: null }4.2用户注册接口接口描述新增普通学生账号项目内容请求 URL/register请求方式POST请求参数JSON 请求体请求体示例{ username: stu003, password: 123456, college: 计算机学院, className: 计科2401, phone: 13900139000, dorm: 东六-201, role: 0, address: 东区宿舍 }成功响应示例{ code: 1, msg: success, data: null }失败响应示例{ code: 0, msg: error, data: null }4.3根据ID查询单个用户项目内容请求 URL/{uid}请求方式GET请求参数路径参数 uid1无 JSON 请求体成功响应示例{ code: 1, msg: success, data: { uid: 1, username: stu001, password: 123456, phone: 13511112222, college: 计算机学院, className: 计科2401, dorm: 东6-202, role: 0, createTime: 2026-06-26 09:20:10, updateTime: 2026-06-26 09:20:10 } }失败响应示例{ code: 0, msg: error, data: null }4.4条件查询用户列表项目内容请求 URL/list请求方式GET请求参数URL 拼接参数无 JSON 请求体 示例/user/list?usernamesturole0成功响应示例{ code: 1, msg: success, data: [ { uid: 1, username: stu001, password: 123456, phone: 13511112222, college: 计算机学院, className: 计科2401, dorm: 东6-202, role: 0, createTime: 2026-06-26 09:20:10, updateTime: 2026-06-26 09:20:10 } ] }失败响应示例{ code: 0, msg: error, data: null }4.5 修改用户项目内容请求 URL/update请求方式PUT请求参数Body JSON必须传 uid请求体示例{ uid: 1, phone: 13699998888, college: 人工智能学院, className: 智科2401, dorm: 西3-401, role: 0 }成功响应示例{ code: 1, msg: success, data: null }失败响应示例{ code: 0, msg: error, data: null }4.6删除用户项目内容请求 URL/{uid}请求方式DELETE请求参数路径参数 uid1无 JSON 请求体成功响应示例{ code: 1, msg: success, data: null }失败响应示例{ code: 0, msg: error, data: null }二、创建数据库、表CREATE DATABASE IF NOT EXISTS myweb; USE myweb; CREATE TABLE user ( uid INT UNSIGNED PRIMARY KEY AUTO_INCREMENT COMMENT 用户ID, username VARCHAR(32) NOT NULL COMMENT 用户名, password VARCHAR(32) NOT NULL DEFAULT 123456 COMMENT 密码, college VARCHAR(30) NOT NULL DEFAULT 管理学院 COMMENT 学院, className VARCHAR(30) DEFAULT 信管2402 COMMENT 班级, phone VARCHAR(11) COMMENT 手机号, dorm VARCHAR(30) DEFAULT 南九-545 COMMENT 宿舍号, role TINYINT NOT NULL DEFAULT 0 COMMENT 0学生 1管理员, address VARCHAR(100) COMMENT 宿舍地址, create_time DATETIME NOT NULL COMMENT 创建时间, update_time DATETIME NOT NULL COMMENT 更新时间 )COMMENT用户表; -- 测试数据 INSERT INTO user(username,password,phone,role,address,create_time,update_time) VALUES (admin,123456,13900139000,1,管理员办公室,NOW(),NOW()), (stu001,123456,13800138000,0,南九567,NOW(),NOW()), (stu002,123456,13700137000,0,北三837,NOW(),NOW());