这是一个JavaWeb小案例的详细实现过程,本文是前端文件的使用与模拟的接口文档,博客的上篇在这里:https://blog.csdn.net/weixin_43760020/article/details/105228035
博客的下篇在这里:https://blog.csdn.net/weixin_43760020/article/details/105292962
假设现在正在进行前后端分离的开发,此时前端已经写好,需要我们根据前端编写的接口文档用Java 进行后端开发。
一、前端编写的接口文档:
注意区分请求参数和响应结果。
一共三个接口,通过JSON数据格式进行交互。如下:
1、接口一
- 方法描述:新生登录
- URL地址:http://localhost:9601/reactLogin/login
- 请求方式:post
- 请求参数:
字段 | 说明 | 类型 | 是否必填 | 备注 |
---|---|---|---|---|
newstuname | 新生姓名 | String | 是 | |
newstuid | 新生学号 | long | 是 | 这是新生登录表的学号 |
- 请求参数示例:
{
newstuname: "博格巴",
newstuid: 202109601260
}
- 响应结果:
约定:
若验证登录成功,返回整型 1。
否则为失败,返回整型 0。
//登录成功,响应结果示例
{
data:1
}
//登录失败,响应结果示例:
{
data:0
}
2、接口二
- 方法描述:初始化新生报道页
- URL地址:http://localhost:9601/reactLogin/initReport
- 请求方式:post
- 请求参数:
字段 | 说明 | 类型 | 是否必填 | 备注 |
---|---|---|---|---|
r_id | 新生学号 | long | 是 | 这是新生登录表的学号 |
- 请求参数示例:
{
r_id