0.示例代码
@RestController @RequestMapping("/user") @Validated public class UserController{
@GetMapping("/page-list") public Result<Object> getPageList(UserQueryDTO dto){
//to do... } }
1.接口说明
根据条件获取用户分页列表
2.接口地址
/user/page-list
3.请求方式
GET
4.请求参数
| 参数名称 | 参数类型 | 参数说明 | 是否必传 | 传参示例 |
|---|---|---|---|---|
| page | Integer | 当前页码,不得小于1 | 是 | 1 |
| pageSize | Integer | 每页大小,不得小于1 | 是 | 10 |
| name | String | 用户姓名 | 否 | 大土 |
5.响应参数
| 参数名称 | 参数类型 | 参数说明 | 参数示例 |
|---|---|---|---|
| code | Integer | 响应编码 | 200 |
| message | String | 响应消息 | “ok” |
| timestamp | String | 响应时间 | “2021-02-03 12:12:12 122” |
| data | Object | 响应实体 | {“total”:66,“rows”:[“id”:1,“name”:“大土”,“age”:21]} |
| total | Long | 数据总量 | 66 |
| rows | List | 每页数据集合 | [“id”:1,“name”:“大土”,“age”:21] |
| id | Long | 用户主键 | 1 |
| name | String | 用户姓名 | “大土” |
| age | Integer | 用户年龄 | 21 |
6.成功示例
//请求 http://localhost:8080/user/page-list?page=1&pageSize=10 //响应 {
"code": 200, "message": "ok", "timestamp": "2021-02-02 20:38:45 252", "data": {
"total": 66, "rows": [ "id": 1, "name": "大土", "age": 21 ] } }
7.异常示例
//请求 http://localhost:8080/user/page-list //响应 {
"code": 400, "message": "parameter can not be null:page", "timestamp": "2021-02-02 20:38:45 252", "data": null }
发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/216635.html原文链接:https://javaforall.net
