接口文档

分页查询

请求地址

$ curl 'http://localhost:8080/users?name=&username=&number=1&size=10&name=&username=' -i -X GET

Table 1. 请求参数
Parameter	Description
`name`	姓名
`username`	用户名
`number`	当前页码
`size`	每页显示

响应报文

{
  "status" : "ok",
  "message" : "操作成功",
  "data" : {
    "dataList" : [ ],
    "totalPages" : 0,
    "totalElements" : 0,
    "size" : 0,
    "number" : 0
  }
}

Table 2. 响应数据
Path	Type	Description
`status`	`String`	状态码
`message`	`String`	状态描述
`data.dataList`	`Array`	数据列表
`data.totalPages`	`Number`	总页数
`data.totalElements`	`Number`	总数
`data.number`	`Number`	页码，实际显示需要+1
`data.size`	`Number`	每页显示

获取用户信息

请求地址

$ curl 'http://localhost:8080/users/1' -i -X GET

Table 3. /users/{id}
Parameter	Description
`id`	用户id

响应报文

{
  "status" : "ok",
  "message" : "操作成功",
  "data" : {
    "id" : 1,
    "name" : "demo",
    "username" : "admin",
    "password" : "1"
  }
}

Table 4. 响应数据
Path	Type	Description
`status`	`String`	状态码
`message`	`String`	状态描述
`data.id`	`Number`	用户id
`data.name`	`String`	姓名
`data.username`	`String`	用户名
`data.password`	`String`	密码

保存用户

请求地址

$ curl 'http://localhost:8080/users' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "demo",
  "username" : "admin",
  "password" : "1"
}'

请求报文

{
  "name" : "demo",
  "username" : "admin",
  "password" : "1"
}

响应报文

{
  "status" : "ok",
  "message" : "操作成功",
  "data" : { }
}

Table 5. 响应数据
Path	Type	Description
`status`	`String`	状态码
`message`	`String`	状态描述
`data`	`User`	用户

删除用户

请求地址

$ curl 'http://localhost:8080/users/1' -i -X DELETE

Table 6. /users/{id}
Parameter	Description
`id`	用户id

响应报文

{
  "status" : "ok",
  "message" : "操作成功"
}

Table 7. 响应数据
Path	Type	Description
`status`	`String`	状态码
`message`	`String`	状态描述