人员信息管理系统接口说明文档

说明

项目的请求根路径为：http://127.0.0.1
以 /api 开头的请求路径，不需要访问权限
以 /my 开头的请求路径，需要在请求头中携带 Authorization 身份认证字段，才能正常访问成功

推荐一款 VSCode 主题： escook-theme

推荐一款 VSCode 单词翻译插件： escook-translate

登录注册

注册

简要描述

用户注册接口

请求URL

http://127.0.0.1/api/reguser

请求方式

POST

请求体

参数名	必选	类型	说明
username	是	string	用户名
password	是	string	密码

返回示例

{
	"status": 0,
	"message": "注册成功！"
}

返回参数说明

参数名	类型	说明
status	int	请求是否成功，0：成功；1：失败
message	string	请求结果的描述消息

{
	"status": 0,
	"message": "登陆成功",
	"token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInBhc3N3b3JkIjoibnVsbCIsIm5pY2tuYW1lIjoiR0NUIiwiZW1haWwiOiIxNjEyNjc0MDE4QHFxLmNvbSIsInVzZXJfcGljIjoiIiwicm9sZSI6IueuoeeQhuWRmCIsImRlcGFydG1lbnRfaWQiOjEsImlhdCI6MTWq2YGuo6paNrw4f9SZqkcB8tCN5XU9g7DfQ.0kUJYcwEj9LYJcDCqjhb225f2IGNi_5_Fw271BBFXT4"
}

返回参数说明

参数名	类型	说明
status	int	请求是否成功，0：成功；1：失败
message	string	请求结果的描述消息
token	string	用于有权限接口的身份认证

个人中心

获取用户的基本信息

简要描述

获取用户基本信息接口

请求URL

http://127.0.0.1/my/userinfo

请求方式

header:

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MywidXNlcm5hbWUiOiIyOTQ2MjgyMDE2IiwicGFzc3dvcmQiOiJudWxsIiwibmlja25hbWUiOm51bGwsImVtYWlsIjpudWxsLCJ1c2VyX3BpYyI6IiIsInJvbGUiOm51bGwsImRlcGFydG1lbnRfaWQiOm51bGwsImlhdCI6MTY5NjMwNzAyMiwiZXhwIjoxNjk2MzQzMDIyfQ.6kUcx7z8PGKOm8WnMVA4NokdPHLbaBQ1aj0i7PYCWuQ

参数

无

返回示例

{
	"status": 0,
	"message": "获取用户基本信息成功！",
	"data": {
		"user_id": 3,
		"username": "2946282016",
		"nickname": null,
		"email": null,
		"role": null,
		"department_name": null,
		"full_name": null,
		"position": null,
		"phone": null,
		"hire_date": null,
		"base_salary": null,
		"bonus": null,
		"deductions": null,
		"salary_month": null
	}
}

返回参数说明

参数名	类型	说明
status	int	请求状态，0 表示成功，1 表示失败
message	string	请求结果的描述消息
user_id	int	用户 ID
username	string	用户名
nickname	string?	用户昵称
email	string?	用户电子邮件
role	string?	用户角色
department_name	string?	用户所在部门名
full_name	string?	用户全名
position	string?	用户职位
phone	string?	用户电话
hire_date	date?	用户的雇佣日期
base_salary	float?	用户的基本工资
bonus	float?	用户的奖金
deductions	float?	扣除金额
salary_month	float?	月薪

更新用户基本信息

简要说明：

更新用户基本信息

请求URL：

http://127.0.0.1/my/userinfo

请求方式

POST

Header：

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MywidXNlcm5hbWUiOiIyOTQ2MjgyMDE2IiwicGFzc3dvcmQiOiJudWxsIiwibmlja25hbWUiOm51bGwsImVtYWlsIjpudWxsLCJ1c2VyX3BpYyI6IiIsInJvbGUiOm51bGwsImRlcGFydG1lbnRfaWQiOm51bGwsImlhdCI6MTY5NjMwNzAyMiwiZXhwIjoxNjk2MzQzMDIyfQ.6kUcx7z8PGKOm8WnMVA4NokdPHLbaBQ1aj0i7PYCWuQ

请求体：

参数名	必选	类型	说明
id	是	number	用户id
nickname	是	string	昵称
email	是	string	邮箱

返回示例：

{
	"status": 0,
	"message": "修改用户基本信息成功！"
}

返回参数说明

参数名	类型	说明
status	int	请求是否成功，0：成功；1：失败
message	string	请求结果的描述消息

重置用户密码

简要说明：

为指定用户重置密码。

请求URL：

http://127.0.0.1/my/updatepwd

请求方式：

POST

Header：

1	Authorization: Bearer <Your-Token-Here>

注意: Bearer Token 会随每次请求改变，因此在上述代码中的 <Your-Token-Here> 需要被替换为实际的token。

请求体：

参数名	必选	类型	说明
oldPwd	是	number	旧密码
newPwd	是	number	新密码

返回示例：

{
	"status": 0,
	"message": "更新密码成功！"
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功；1：失败
message	string	请求结果的描述消息

更新用户头像

简要说明：

允许用户更新其个人头像。

请求URL：

http://127.0.0.1/my/update/avatar

请求方式：

POST

Header：

1	Authorization: Bearer <Your-Token-Here>

注意: Bearer Token 会随每次请求改变，因此在上述代码中的 <Your-Token-Here> 需要被替换为实际的token。

请求体：

参数名	必选	类型	说明
avatar	是	formData	用户的新头像

注意: 头像通常作为文件上传，因此数据类型为 formData，这要求使用 multipart/form-data 的内容类型。

返回示例：

{
	"status": 0,
	"message": "头像更新头像成功！",
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功；1：失败
message	string	请求结果的描述消息

部门

获取部门列表

简要说明：

获取系统中所有部门的列表信息。

请求URL：

http://127.0.0.1/my/department/departments

请求方式：

Header：

1	Authorization: Bearer <Your-Token-Here>

注意: Bearer Token 会随每次请求改变，因此在上述代码中的 <Your-Token-Here> 需要被替换为实际的token。

请求参数：
无

返回示例：

{
	"status": 0,
	"message": "获取部门列表成功！",
	"data": [
		{
			"id": 1,
			"department_name": "Department 1",
			"manager_id": 1,
			"is_delete": 0
		},
		{
			"id": 3,
			"department_name": "Department 3",
			"manager_id": null,
			"is_delete": 0
		},
		{
			"id": 4,
			"department_name": "Department 4",
			"manager_id": null,
			"is_delete": 0
		}
	]
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功；1：失败
message	string	请求结果的描述消息
data	array	部门的列表数据
data[].id	number	部门的ID号
data[].department_name	string	部门的名称
data[].manager_id	number/null	负责该部门的经理的ID号，若无则为null
data[].is_delete	int	部门的删除状态，0：未删除；1：已删除

获取特定部门信息

简要说明：

根据部门ID获取特定部门的详细信息。

请求URL：

http://127.0.0.1/my/department/departments/2

请求方式：

Header：

1	Authorization: Bearer <Your-Token-Here>

注意: Bearer Token 会随每次请求改变，因此在上述代码中的 <Your-Token-Here> 需要被替换为实际的token。

请求参数：
无 (参数已经包含在URL路径中)

返回示例：

{
	"status": 0,
	"message": "获取部门数据成功！",
	"data": {
		"id": 2,
		"department_name": "Department 2",
		"manager_id": null,
		"is_delete": 1
	}
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功；1：失败
message	string	请求结果的描述消息
data	object	部门的详细数据
data.id	number	部门的ID号
data.department_name	string	部门的名称
data.manager_id	number/null	负责该部门的经理的ID号，若无则为null
data.is_delete	int	部门的删除状态，0：未删除；1：已删除

删除特定部门

简要说明：

根据部门ID删除特定部门。

请求URL：

http://127.0.0.1/my/department/deletedepartments/2

请求方式：

Header：

1	Authorization: Bearer <Your-Token-Here>

注意: Bearer Token 会随每次请求改变，因此在上述代码中的 <Your-Token-Here> 需要被替换为实际的token。

请求参数：
无 (参数已经包含在URL路径中)

返回示例：

{
	"status": 0,
	"message": "删除部门成功！"
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功；其他：失败
message	string	请求结果的描述消息

新增部门分类

简要说明：

在系统中新增部门分类。

请求URL：

http://127.0.0.1/my/department/adddepartments

请求方式：

POST

Header：

1	Authorization: Bearer <Your-Token-Here>

注意: Bearer Token 会随每次请求改变，因此在上述代码中的 <Your-Token-Here> 需要被替换为实际的token。

请求体：

参数名	必选	类型	说明
department_name	是	string	新增部门名称

返回示例：

{
	"status": 0,
	"message": "新增部门分类成功！"
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息

更新部门名称

简要说明：

在系统中更新已有部门的名称。

请求URL：

http://127.0.0.1/my/department/updatedepartment

请求方式：

POST

Header：

1	Authorization: Bearer <Your-Token-Here>

请求体：

参数名	必选	类型	说明
id	是	number	更新部门ID
department_name	是	string	更新部门名称

返回示例：

{
	"status": 0,
	"message": "更新部门名称成功!"
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息

员工

获取员工列表

简要说明：

获取系统中所有员工的列表信息。

请求URL：

http://127.0.0.1/my/employee/employees

请求方式：

Header：

1	Authorization: Bearer <Your-Token-Here>

请求参数：
无

返回示例：

{
	"status": 0,
	"message": "获取员工列表成功！",
	"data": [
		{
			"id": 1,
			"user_id": 1,
			"full_name": "小红",
			"position": "老板",
			"phone": "15194540853",
			"hire_date": "2023-01-01T16:00:00.000Z",
			"is_delete": 0
		},
		// ...其他员工数据
	]
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息
data	array	员工的列表数据
data[].id	number	员工的ID号
data[].user_id	number	员工关联的用户ID
data[].full_name	string	员工的全名
data[].position	string	员工的职位
data[].phone	string	员工的电话
data[].hire_date	string	员工的雇佣日期 (ISO格式)
data[].is_delete	int	员工的删除状态，0：未删除；1：已删除

新增员工

简要说明：

在系统中新增一个员工。

请求URL：

http://127.0.0.1/my/employee/addemployee

请求方式：

POST

Header：

1	Authorization: Bearer <Your-Token-Here>

请求体：

参数名	类型	说明
user_id	number	员工关联的用户ID
full_name	string	员工的全名
position	string	员工的职位
phone	string	员工的电话
hire_date	date	员工的雇佣日期

返回示例：

{
	"status": 0,
	"message": "新增员工成功！"
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息

删除指定员工

简要说明：

在系统中删除指定ID的员工。

请求URL：

http://127.0.0.1/my/employee/deleteemployee/1

请求方式：

DELETE

Header：

1	Authorization: Bearer <Your-Token-Here>

请求参数：
无 (参数已经包含在URL路径中)

返回示例：

{
	"status": 0,
	"message": "删除员工成功！"
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息

恢复指定员工

简要说明：

在系统中恢复指定ID的员工。

请求URL：

http://127.0.0.1/my/employee/restoreemployee/1

请求方式：

POST

Header：

1	Authorization: Bearer <Your-Token-Here>

请求参数：
无 (参数已经包含在URL路径中)

返回示例：

{
	"status": 0,
	"message": "恢复员工成功！"
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息

获取指定员工数据

简要说明：

根据员工ID获取该员工的详细数据。

请求URL：

http://127.0.0.1/my/employee/employee/3

请求方式：

Header：

1	Authorization: Bearer <Your-Token-Here>

请求参数：
无 (参数已经包含在URL路径中)

返回示例：

{
	"status": 0,
	"message": "获取员工数据成功！",
	"data": {
		"id": 3,
		"user_id": 3,
		"full_name": "小风",
		"position": "员工",
		"phone": "15194540853",
		"hire_date": "2023-01-01T16:00:00.000Z",
		"is_delete": 0
	}
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息
data	object	员工的详细数据
data.id	number	员工的ID号
data.user_id	number	员工关联的用户ID
data.full_name	string	员工的全名
data.position	string	员工的职位
data.phone	string	员工的电话
data.hire_date	date	员工的雇佣日期
data.is_delete	int	员工的删除状态，0：未删除；1：已删除

更新指定员工信息

简要说明：

在系统中更新指定员工的信息。

请求URL：

http://127.0.0.1/my/employee/updateemployee

请求方式：

Header：

1	Authorization: Bearer <Your-Token-Here>

请求体：

参数名	类型	说明
id	number	员工的ID号
user_id	number	员工关联的用户ID
full_name	string	员工的全名
position	string	员工的职位
phone	string	员工的电话
hire_date	date	员工的雇佣日期

返回示例：

{
	"status": 0,
	"message": "更新员工信息成功!"
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息

薪资

获取薪资列表

简要说明：

获取系统中所有员工的薪资列表信息。

请求URL：

http://127.0.0.1/my/salaries/

请求方式：

Header：

1	Authorization: Bearer <Your-Token-Here>

请求参数：
无

返回示例：

{
	"status": 0,
	"message": "获取薪资列表成功！",
	"data": [
		{
			"id": 1,
			"employee_id": 1,
			"base_salary": 6000,
			"bonus": 500,
			"deductions": 100,
			"month": "2023-01-01T16:00:00.000Z",
			"is_delete": 0
		},
		// ...其他员工薪资数据
	]
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息
data	array	员工薪资的列表数据
data[].id	number	薪资的ID号
data[].employee_id	number	薪资关联的员工ID
data[].base_salary	number	员工的基本薪资
data[].bonus	number	员工的奖金
data[].deductions	number	员工的扣款
data[].month	date	薪资的月份
data[].is_delete	int	薪资的删除状态，0：未删除；1：已删除

获取指定员工薪资

简要说明：

根据薪资ID获取指定的薪资数据。

请求URL：

http://127.0.0.1/my/salaries/1

请求方式：

Header：

1	Authorization: Bearer <Your-Token-Here>

请求参数：
无 (参数已经包含在URL路径中)

返回示例：

{
	"status": 0,
	"message": "获取薪资数据成功！",
	"data": {
		"id": 1,
		"employee_id": 1,
		"base_salary": 6000,
		"bonus": 500,
		"deductions": 100,
		"month": "2023-01-01T16:00:00.000Z",
		"is_delete": 0
	}
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息
data	object	员工薪资的详细数据
data.id	number	薪资的ID号
data.employee_id	number	薪资关联的员工ID
data.base_salary	number	员工的基本薪资
data.bonus	number	员工的奖金
data.deductions	number	员工的扣款
data.month	date	薪资的月份
data.is_delete	int	薪资的删除状态，0：未删除；1：已删除

删除指定薪资

简要说明：

根据薪资ID删除指定的薪资数据。

请求URL：

http://127.0.0.1/my/salaries/delete/1

请求方式：

Header：

1	Authorization: Bearer <Your-Token-Here>

请求参数：
无 (参数已经包含在URL路径中)

返回示例：

{
	"status": 0,
	"message": "删除薪资数据成功！"
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息

更新指定薪资

简要说明：

在系统中更新指定的薪资数据。

请求URL：

http://127.0.0.1/my/salaries/update

请求方式：

POST

Header：

1	Authorization: Bearer <Your-Token-Here>

请求体：

参数名	类型	说明
id	number	薪资的ID号
base_salary	number	员工的基本薪资
bonus	number	员工的奖金
deductions	number	员工的扣款
month	date	薪资的月份

返回示例：

{
	"status": 0,
	"message": "更新薪资数据成功！"
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息

新增薪资

简要说明：

在系统中新增薪资数据。

请求URL：

http://127.0.0.1/my/salaries/add

请求方式：

POST

Header：

1	Authorization: Bearer <Your-Token-Here>

请求体：

参数名	类型	说明
employee_id	number	员工的ID号
base_salary	number	员工的基本薪资
bonus	number	员工的奖金
deductions	number	员工的扣款
month	date	薪资的月份

返回示例：

{
	"status": 0,
	"message": "新增薪资成功！"
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息

公告

发布公告

简要说明：

在系统中发布新公告。

请求URL：

http://127.0.0.1/my/announcements/add

请求方式：

POST

Header：

1	Authorization: Bearer <Your-Token-Here>

请求体：

参数名	类型	说明
title	string	公告的标题
content	string	公告的内容
created_at	date	公告的创建日期

返回示例：

{
	"status": 0,
	"message": "发布公告成功"
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息

获取公告列表

简要说明：

在系统中获取所有公告的列表。

请求URL：

http://127.0.0.1/my/announcements/list

请求方式：

Header：

1	Authorization: Bearer <Your-Token-Here>

请求参数：
无

返回示例：

{
	"status": 0,
	"message": "获取公告列表成功！",
	"data": [
		{
			"id": 1,
			"title": "Announcement 1",
			"content": "Content of the first announcement",
			"created_at": "2023-10-01T12:47:06.000Z",
			"is_delete": 0
		},
		// ...其他公告数据
	]
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息
data	array	公告的列表数据
data[].id	number	公告的ID号
data[].title	string	公告的标题
data[].content	string	公告的内容
data[].created_at	date	公告的创建日期
data[].is_delete	int	公告的删除状态，0：未删除；1：已删除

删除指定公告

简要说明：

根据公告ID删除指定的公告。

请求URL：

http://127.0.0.1/my/announcements/delete/4

请求方式：

Header：

1	Authorization: Bearer <Your-Token-Here>

请求参数：
无 (参数已经包含在URL路径中)

返回示例：

{
	"status": 0,
	"message": "删除公告成功！"
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息

更新指定公告

简要说明：

在系统中更新指定的公告内容。

请求URL：

http://127.0.0.1/my/announcements/updateanncements

请求方式：

POST

Header：

1	Authorization: Bearer <Your-Token-Here>

请求体：

参数名	类型	说明
id	number	公告的ID号
title	string	公告的标题
content	string	公告的内容

返回示例：

{
	"status": 0,
	"message": "更新公告成功!"
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息

获取指定公告

简要说明：

根据公告ID获取指定的公告数据。

请求URL：

http://127.0.0.1/my/announcements/announcements/1

请求方式：

Header：

1	Authorization: Bearer <Your-Token-Here>

请求参数：
无 (参数已经包含在URL路径中)

返回示例：

{
	"status": 0,
	"message": "获取公告数据成功！",
	"data": {
		"id": 1,
		"title": "Announcement 1",
		"content": "Content of the first announcement",
		"created_at": "2023-10-01T12:47:06.000Z",
		"is_delete": 0
	}
}

返回参数说明：

参数名	类型	说明
status	int	请求是否成功，0：成功
message	string	请求结果的描述消息
data	object	公告的详细数据
data.id	number	公告的ID号
data.title	string	公告的标题
data.content	string	公告的内容
data.created_at	date	公告的创建日期
data.is_delete	int	公告的删除状态，0：未删除；1：已删除