学生管理系统 API 接口文档

1. 学生管理 API 接口文档

1.1. API 接口说明

• 接口基准地址：http://121.199.57.133:8080/
• 服务端已开启 CORS 跨域支持
• 使用 HTTP Status Code 标识状态
• 数据返回格式统一使用 JSON

1.1.1. 支持的请求方法

• GET（SELECT）：从服务器取出资源（一项或多项）。
• POST（CREATE）：在服务器新建一个资源。
• PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
• DELETE（DELETE）：从服务器删除资源。

1.1.2. 通用返回状态说明

状态码	含义	说明
200	OK	请求成功
201	CREATED	创建成功
204	DELETED	删除成功
400	BAD REQUEST	请求的地址不存在或者包含不支持的参数
401	UNAUTHORIZED	未授权
403	FORBIDDEN	被禁止访问
404	NOT FOUND	请求的资源不存在
422	Unprocesable entity	[POST/PUT] 当创建一个对象时，发生一个验证错误
500	INTERNAL SERVER ERROR	内部错误

---

1.2. 管理员服务

1.2.1. 登录

• 请求路径：admin
• 请求方法：post
• 请求方法名method=login
• 请求参数

参数名	参数说明	备注
username	用户名	不能为空
password	密码	不能为空

• 响应数据

正确演示：
{
   
    "data": {
   
        "password": "abc123",
        "username": "zzm"
    },
    "meta": {
   
        "msg": "登陆成功",
        "StatusCode": 200
    }
}
错误演示：{
   
    "data": {
   
        "password": "123456",
        "username": "ljk"
    },
    "meta": {
   
        "msg": "登陆失败",
        "StatusCode": 202
    }
}

1.2.2.注销

• 请求路径：admin
• 请求方法：post
• 请求方法名method=logout
• 相应数据

{
   "meta":{
   "msg":"注销成功","status":200}}

1.2.3 注册

• 请求路径：admin

• 请求方法：post

• 请求方法名method=register

• 相应数据

  正确演示：
  {
       
      "data": {
       
          "password": "123456",
          "username"