API接口设计模板

API

员工登录接口设计

基本信息

Path： /admin/staff/login
**Method：**POST
接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
username	是	admin	用户名
password	是	mima	密码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须
data	String	必须
data_id	Long	必须
data_username	String	必须
data_phone	String	必须
data_status	int	必须
data_token	String	必须
msg	String	非必须

新增员工

基本信息

Path： /admin/staff/add
**Method：**POST
接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
name	是	张三	员工姓名
username	是	admin	用户名
password	是	123456	密码
phone	是	15631120136	手机号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须
data	String	非必须
msg	String	非必须

修改员工信息

基本信息

Path： /admin/staff/update
**Method：**POST
接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
name	是	张三	员工姓名
username	是	admin	用户名
password	是	123456	密码
phone	是	15631120136	手机号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须
data	String	非必须
msg	String	非必须

修改员工状态

基本信息

Path： /admin/staff/status
**Method：**GET
接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
username	是	admin	用户名
status	是	1	员工当前状态

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须
data	String	非必须
msg	String	非必须

删除员工

基本信息

Path： /admin/staff/delete
**Method：**GET
接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
username	是	admin	用户名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须
data	String	非必须
msg	String	非必须

动态分页查询员工

基本信息

Path： /admin/staff/page
**Method：**GET
接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	1	页码
pageSize	是	10	每页显示记录数
name	否	张三	员工姓名
username	否	zhangsan	用户名
status	否	（正常）	状态

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须
data	String	必须
I—list	List	必须		当前页的数据集合
I—total	Long	必须		总记录数
msg	String	非必须