IconCreated with Sketch.

YAPI 接口文档

YApi
  • 学生业务
    • 修改学生信息
    • 删除学生信息
    • 打印成绩单
    • 查询学生信息
  • 班级业务接口
    • 查询班级信息

EasyYapi导入测试

学生业务

修改学生信息

基本信息

Path: /yapi/student/updateStudent

Method: POST

接口描述:

这是接口备注:类字段上有javax.validation注解、EasyYapi规定的关键字“@required”时,生成的接口字段为“必须”字段

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型是否必须默认值备注其他信息
idinteger必须学号

mock: @natural

namestring必须姓名

mock: @cname

sexinteger非必须性别: 0-男、1-女

mock: @pick([0, 1])

idNostring非必须身份证号码

mock: @id

birthdaystring非必须出生日期

mock: @datetime("yyyy-MM-dd")

entryDatestring必须入学日期

mock: @date

phonestring非必须手机号

mock: 1@pick(["3","4","5","7","8"])@string("number", 9)

gradeIdinteger非必须1班级id

mock: 1

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须处理成功的标识: true-成功,false-失败

mock: true

messagestring必须处理消息

mock: 处理成功

dataobject非必须处理数据

删除学生信息

基本信息

Path: /yapi/student/deleteStudent

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型是否必须默认值备注其他信息
idinteger必须学号

mock: @natural

namestring必须姓名

mock: @cname

sexinteger非必须性别: 0-男、1-女

mock: @pick([0, 1])

idNostring非必须身份证号码

mock: @id

birthdaystring非必须出生日期

mock: @datetime("yyyy-MM-dd")

entryDatestring必须入学日期

mock: @date

phonestring非必须手机号

mock: 1@pick(["3","4","5","7","8"])@string("number", 9)

gradeIdinteger非必须1班级id

mock: 1

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须处理成功的标识: true-成功,false-失败

mock: true

messagestring必须处理消息

mock: 处理成功

dataobject非必须处理数据

打印成绩单

基本信息

Path: /yapi/yapi/student/report

Method: POST

接口描述:

请求参数

查询学生信息

基本信息

Path: /yapi/student/getStudent

Method: POST

接口描述:

这是接口备注:首行注释为“接口名字”,后面的注释为“接口备注”

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型是否必须默认值备注其他信息
idinteger必须学号

mock: @natural

namestring必须姓名

mock: @cname

sexinteger非必须性别: 0-男、1-女

mock: @pick([0, 1])

idNostring非必须身份证号码

mock: @id

birthdaystring非必须出生日期

mock: @datetime("yyyy-MM-dd")

entryDatestring必须入学日期

mock: @date

phonestring非必须手机号

mock: 1@pick(["3","4","5","7","8"])@string("number", 9)

gradeIdinteger非必须1班级id

mock: 1

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须处理成功的标识: true-成功,false-失败

mock: true

messagestring必须处理消息

mock: 处理成功

dataobject非必须处理数据
├─ idinteger必须学号

mock: @natural

├─ namestring必须姓名

mock: @cname

├─ sexinteger非必须性别: 0-男、1-女

mock: @pick([0, 1])

├─ idNostring非必须身份证号码

mock: @id

├─ birthdaystring非必须出生日期

mock: @datetime("yyyy-MM-dd")

├─ entryDatestring必须入学日期

mock: @date

├─ phonestring非必须手机号

mock: 1@pick(["3","4","5","7","8"])@string("number", 9)

├─ gradeIdinteger非必须1班级id

mock: 1

班级业务接口

查询班级信息

基本信息

Path: /yapi/grade/getGrade

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型是否必须默认值备注其他信息
idinteger非必须班级id

mock: @integer(1, 10)

namestring非必须班级名字

mock: @cword("一二三四五六七八九十")班

返回数据

名称类型是否必须默认值备注其他信息
successboolean必须处理成功的标识: true-成功,false-失败

mock: true

messagestring必须处理消息

mock: 处理成功

dataobject非必须处理数据
├─ idinteger非必须班级id

mock: @integer(1, 10)

├─ namestring非必须班级名字

mock: @cword("一二三四五六七八九十")班

Build by YMFE.