功能点接口文档

URL:http://localhost:8080/users/register

 用户注册接口

请求方式:post

请求路径:/api/users/register

请求体:包含用户名、密码、姓名、专业、班级、学号等信息

请求参数:

用户名     数据类型   备注    是否必须

username    String     用户名     是

password    String     密码       是

name   String      姓名      是

major     String      专业      是

classname      String      班级      是

student_id       String      学号      是

响应参数: 状态码(status):整数,表示操作结果的状态

提示信息(message):字符串,表示操作结果的提示信息

响应:注册成功或失败的消息

返回值 :json数据

{

Recode:200,

Message:”success/fail”

Data:{

“注册结果”:“注册成功”

}

{

“注册结果”:“注册失败,密码过短”

}

用户信息删除接口

请求方式:post

请求路径:/api/users/{username}

请求参数:

用户名     数据类型   备注    是否必须

username    String     用户名     是

响应:删除成功或失败的消息

返回值 :json数据

{

 Recode:200,

Message:”success/fail”

Data:{

“删除结果”:“删除成功”

}

{

“删除结果”:“删除失败,无法找到该用户相关信息”

}

用户信息修改接口

请求方式:post

请求路径:/api/users/{username}

请求参数:密码

用户名     数据类型   备注    是否必须

password    String     密码       是

请求体:包含需要修改的信息(姓名、专业、班级)

响应:修改成功或失败的消息

返回值 :json数据

{

 Recode:200,

Message:”success/fail”

Data:{

“修改结果”:“修改成功”

}

{

“修改结果”:“修改失败,密码格式错误”

}

用户信息查询接口

请求方式:get

请求路径:/api/users/search

请求参数:可能包含姓名、专业、班级、学号等查询条件

请求参数:

用户名     数据类型   备注    是否必须

username    String     用户名     是

password    String     密码       是

name    String      姓名      是

major     String      专业      是

classname       String      班级      是

student_id       String      学号      是

响应:符合查询条件的用户信息列表

返回值 :json数据

{

 Recode:200,

Message:”success/fail”

Data:{

"username": “xcdd”

“password”:”123456”

    "name": "李华",

    "major": “计算机网络”,

"classname": "网络2201",

“student_id”:”2375478”

  }

}

返回值说明:

Recode:状态码

200:(成功) 服务器已成功处理了请求。 通常,这表示服务器提供了请求的网页。

204:(无内容) 服务器成功处理了请求,但没有返回任何内容。

400:(错误请求) 服务器不理解请求的语法。

401:(未授权) 请求要求身份验证。 对于需要登录的网页,服务器可能返回此响应。

404:(未找到) 服务器找不到请求的网页。

500:(服务器内部错误) 服务器遇到错误,无法完成请求。

501:(尚未实施) 服务器不具备完成请求的功能。 例如,服务器无法识别请求方法时可能会返回此代码。

Message:返回消息

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值