欢迎来到尧图网

客户服务 关于我们

您的位置:首页 > 新闻 > 社会 > API接口设计模板

API接口设计模板

2025/1/29 8:10:10 来源:https://blog.csdn.net/Annaday/article/details/145372871  浏览:    关键词:API接口设计模板

API

员工登录接口设计

基本信息

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

请求参数

Query

参数名称是否必须示例备注
usernameadmin用户名
passwordmima密码

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须
dataString必须
data_idLong必须
data_usernameString必须
data_phoneString必须
data_statusint必须
data_tokenString必须
msgString非必须

新增员工

基本信息

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

请求参数

Query

参数名称是否必须示例备注
name张三员工姓名
usernameadmin用户名
password123456密码
phone15631120136手机号

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须
dataString非必须
msgString非必须

修改员工信息

基本信息

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

请求参数

Query

参数名称是否必须示例备注
name张三员工姓名
usernameadmin用户名
password123456密码
phone15631120136手机号

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须
dataString非必须
msgString非必须

修改员工状态

基本信息

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

请求参数

Query

参数名称是否必须示例备注
usernameadmin用户名
status1员工当前状态

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须
dataString非必须
msgString非必须

删除员工

基本信息

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

请求参数

Query

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

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须
dataString非必须
msgString非必须

动态分页查询员工

基本信息

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

请求参数

Query

参数名称是否必须示例备注
page1页码
pageSize10每页显示记录数
name张三员工姓名
usernamezhangsan用户名
status(正常)状态

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须
dataString必须
I—listList必须当前页的数据集合
I—totalLong必须总记录数
msgString非必须

版权声明:

本网仅为发布的内容提供存储空间,不对发表、转载的内容提供任何形式的保证。凡本网注明“来源:XXX网络”的作品,均转载自其它媒体,著作权归作者所有,商业转载请联系作者获得授权,非商业转载请注明出处。

我们尊重并感谢每一位作者,均已注明文章来源和作者。如因作品内容、版权或其它问题,请及时与我们联系,联系邮箱:809451989@qq.com,投稿邮箱:809451989@qq.com