我们新的AI设计方式,将基于下述核心流程
问小白不能同时支持:图片、附件的形式,所以本章节我们的分析将回到:https://chat.deepseek.com/
1.部门管理接口设计
上传资料中的两个关键信息:
资料\01. 页面原型\截图\部门管理.png
资料\04. 接口文档\接口文档模板.pdf
加上关键性的提示语
请严格根据提供的部门管理的页面原型和需求说明,以及提供的接口文档的模板,参照提供的部门表dept的表结构,基于Restful风格,帮我设计部门管理模块涉及到的接口文档。dept部门表的表结构如下:
CREATE TABLE dept(
id INT AUTO INCREMENT PRIMARY KEY COMMENT'部门ID(唯一标识,自增主键)'name VARCHAR(10) NOT NULL UNIQUE COMMENT'部门名称”create time DATETIME NOT NULL DEFAULT CURRENT TIMESTAMP COMMENT '创建时间'update time DATETIME NOT NULL DEFAULT CURRENT TIMESTAMP ON UPDATECURRENT TIMESTAMP COMMENT'最后操作时间')ENGINE=InnODB DEFAULT CHARSET=utf8mb4 COMMENT='部门信息表”;
耐心等待之后,可以发现跟我们需要的模板是一致的【可以自行详细分析】
1.1 部门列表查询
1.2 删除部门
基本信息
请求路径:/depts/{id}
请求方式:DELETE
接口描述:该接口用于根据ID删除部门数据
请求参数
参数格式:路径参数
参数说明:
参数名
类型
是否必须
备注
id
number
必须
部门ID
请求参数样例:
/depts/1
/depts/2
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
1.3 添加部门
基本信息
请求路径:/depts
请求方式:POST
接口描述:该接口用于添加部门数据
请求参数
格式:application/json
参数说明:
参数名
类型
是否必须
备注
name
string
必须
部门名称
请求参数样例:
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
1.4 根据ID查询
基本信息
请求路径:/depts/{id}
请求方式:GET
接口描述:该接口用于根据ID查询部门数据
请求参数
参数格式:路径参数
参数说明:
参数名
类型
是否必须
备注
id
number
必须
部门ID
请求参数样例:
/depts/1
/depts/3
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
|- id
number
非必须
id
|- name
string
非必须
部门名称
|- createTime
string
非必须
创建时间
|- updateTime
string
非必须
修改时间
响应数据样例:
1.5 修改部门
基本信息
请求路径:/depts
请求方式:PUT
接口描述:该接口用于修改部门数据
请求参数
格式:application/json
参数说明:
参数名
类型
是否必须
备注
id
number
必须
部门ID
name
string
必须
部门名称
请求参数样例:
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
2.员工管理
2.1 员工列表查询
基本信息
请求路径:/emps
请求方式:GET
接口描述:该接口用于员工列表数据的条件分页查询
请求参数
参数格式:queryString
参数说明:
参数名称
是否必须
示例
备注
name
否
张
姓名
gender
否
1
性别 , 1 男 , 2 女
begin
否
2010-01-01
范围匹配的开始时间(入职日期)
end
否
2020-01-01
范围匹配的结束时间(入职日期)
page
是
1
分页查询的页码,如果未指定,默认为1
pageSize
是
10
分页查询的每页记录数,如果未指定,默认为10
请求数据样例:
/emps?page=1&pageSize=10
/emps?name=张&page=1&pageSize=10
/emps?gender=1&page=1&pageSize=10
/emps?name=张&gender=1&page=1&pageSize=10
/emps?name=张&gender=1&begin=2007-09-01&end=2022-09-01&page=1&pageSize=10
响应数据
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
code
number
必须
响应码, 1 成功 , 0 失败
msg
string
非必须
提示信息
data
object
必须
返回的数据
|- total
number
必须
总记录数
|- rows
object []
必须
数据列表
|- id
number
非必须
id
|- username
string
非必须
用户名
|- name
string
非必须
姓名
|- gender
number
非必须
性别 , 1 男 ; 2 女
|- image
string
非必须
图像
|- position
number
非必须
职位, 说明: 1 班主任,2 讲师, 3 学工主管, 4 教研主管, 5 咨询师
|- salary
number
非必须
薪资
|- hireDate
string
非必须
入职日期
|- deptId
number
非必须
部门id
|- deptName
string
非必须
部门名称
|- createTime
string
非必须
创建时间
|- updateTime
string
非必须
更新时间
响应数据样例:
2.2 删除员工
基本信息
请求路径:/emps
请求方式:DELETE
接口描述:该接口用于批量删除员工的数据信息
请求参数
参数格式:查询参数
参数说明:
参数名
类型
示例
是否必须
备注
ids
数组 array
1,2,3
必须
员工的id数组
请求参数样例:/emps?ids=1,2,3
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
2.3 添加员工
基本信息
请求路径:/emps
请求方式:POST
接口描述:该接口用于添加员工的信息
请求参数
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
username
string
必须
用户名
name
string
必须
姓名
gender
number
必须
性别, 说明: 1 男, 2 女
image
string
非必须
图像
deptId
number
非必须
部门id
hireDate
string
非必须
入职日期
position
number
非必须
职位, 说明: 1 班主任,2 讲师, 3 学工主管, 4 教研主管, 5 咨询师
salary
number
非必须
薪资
exprList
object[]
非必须
工作经历列表
|- company
string
非必须
所在公司
|- position
string
非必须
职位
|- startDate
string
非必须
开始时间
|- endDate
string
非必须
结束时间
请求数据样例:
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
2.4 根据ID查询
基本信息
请求路径:/emps/{id}
请求方式:GET
接口描述:该接口用于根据主键ID查询员工的信息
请求参数
参数格式:路径参数
参数说明:
参数名
类型
是否必须
备注
id
number
必须
员工ID
请求参数样例:/emps/1
响应数据
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
code
number
必须
响应码, 1 成功 , 0 失败
msg
string
非必须
提示信息
data
object
必须
返回的数据
|- id
number
非必须
id
|- username
string
非必须
用户名
|- name
string
非必须
姓名
|- password
string
非必须
密码
|- hireDate
string
非必须
入职日期
|- gender
number
非必须
性别 , 1 男 ; 2 女
|- image
string
非必须
图像
|- position
number
非必须
职位, 说明: 1 班主任,2 讲师, 3 学工主管, 4 教研主管, 5 咨询师
|- salary
number
非必须
薪资
|- deptId
number
非必须
部门id
|- createTime
string
非必须
创建时间
|- updateTime
string
非必须
更新时间
|- exprList
object[]
非必须
工作经历列表
|- id
number
非必须
ID
|- company
string
非必须
所在公司
|- position
string
非必须
职位
|- startDate
string
非必须
开始时间
|- endDate
string
非必须
结束时间
|- empId
number
非必须
员工ID
响应数据样例:
2.5 修改员工
基本信息
请求路径:/emps
请求方式:PUT
接口描述:该接口用于修改员工的数据信息
请求参数
参数格式:application/json
参数说明:
名称
类型
是否必须
备注
id
number
必须
id
username
string
必须
用户名
name
string
必须
姓名
gender
number
必须
性别, 说明: 1 男, 2 女
image
string
非必须
图像
deptId
number
非必须
部门id
hireDate
string
非必须
入职日期
position
number
非必须
职位, 说明: 1 班主任,2 讲师, 3 学工主管, 4 教研主管, 5 咨询师
salary
number
非必须
薪资
exprList
object[]
非必须
工作经历列表
|- id
number
非必须
ID
|- company
string
非必须
所在公司
|- position
string
非必须
职位
|- startDate
string
非必须
开始时间
|- endDate
string
非必须
结束时间
|- empId
number
非必须
员工ID
请求数据样例:
JSON
{
"id": 2,
"username": "zhangwuji",
"password": "123456",
"name": "张无忌",
"gender": 1,
"image": "https://web-framework.oss-cn-hangzhou.aliyuncs.com/2022-09-02-00-27-53B.jpg",
"position": 2,
"salary": 8000,
"hireDate": "2015-01-01",
"deptId": 2,
"createTime": "2022-09-01T23:06:30",
"updateTime": "2022-09-02T00:29:04",
"exprList": [
{
"id": 1,
"startDate": "2012-07-01",
"endDate": "2015-06-20",
"company": "中软国际股份有限公司",
"position": "java开发",
"empId": 2
},
{
"id": 2,
"startDate": "2015-07-01",
"endDate": "2019-03-03",
"company": "百度科技股份有限公司",
"position": "java开发",
"empId": 2
},
{
"id": 3,
"startDate": "2019-3-15",
"endDate": "2023-03-01",
"company": "阿里巴巴科技股份有限公司",
"position": "架构师",
"empId": 2
}
]
}
响应数据
参数格式:application/json
参数说明:
参数名
类型
是否必须
备注
code
number
必须
响应码,1 代表成功,0 代表失败
msg
string
非必须
提示信息
data
object
非必须
返回的数据
响应数据样例:
JSON
{
"code":1,
"msg":"success",
"data":null
}