REST请求规范 | |||||||
POST | POST LIST | GET | GET LIST | PUT | DELETE | DELETE LIST | |
URL | POST /v1/users { username: "aaaa", password: "111111", email: "aaaa@email.com" } | POST /v1/users { users: [ { username: "aaaa", password: "111111", email: "aaaa@email.com" } ] } | GET /v1/users/1 | GET /v1/users?page=1&limit=20&sort=id&direction=desc,其中page为当前页数,limit为页面显示条数,sort为排序字段名称,direction为排序方向 | PUT /v1/users/1 { email: "bbbb@email.com" } | DELETE /v1/users/1 | DELETE /v1/users { userIds: [1, 2, 3] } |
业务成功 | HttpStatus为200,返回创建成功的资源定义,例如: { username: "aaaa"; email: "aaaa@email.com" } | HttpStatus为200,返回空的消息体 | HttpStatus为200,返回单个资源定义,例如: { username: "aaaa"; email: "aaaa@email.com" } | HttpStatus为200,返回多个资源定义列表,total表示符合条件的记录总数,list返回一页数据。例如: { total: 290; list: [ { username: "aaaa"; email: "aaaa@email.com" } ] } | HttpStatus为200,返回修改成功的资源定义,例如: { username: "aaaa"; email: "bbbb@email.com" } | HttpStatus为200,返回空的消息体 | HttpStatus为200,返回空的消息体 |
未找到资源 | NULL | NULL | 1、设置HttpStatus为400; 2、消息体为 { code: "400", message:"Resource not found." } | 1、设置HttpStatus为400; 2、消息体为 { code: "400", message:"Resource not found." } | 1、设置HttpStatus为400; 2、消息体为 { code: "400", message:"Resource not found." } | 1、设置HttpStatus为400; 2、消息体为 { code: "400", message:"Resource not found." } | NULL |
业务失败 | 1、设置HttpStatus为400或500; 2、消息体为, 如果需要可以增加data中设置错误数据 { code: "500", message:"Create resource failed.", data: Object } | 1、已插入的数据全部回滚; 2、设置HttpStatus为400或500; 3、消息体为, 如果需要可以增加data中设置错误数据 { code: "500", message:"Create resource failed.", data: Object } | 1、设置HttpStatus为400或500; 2、消息体为 { code: "500", message:"Get resource failed." } | 1、设置HttpStatus为400或500; 2、消息体为 { code: "500", message:"Get list resource failed." } | 1、设置HttpStatus为400或500; 2、消息体为 { code: "500", message:"Put resource failed." } | 1、设置HttpStatus为400或500; 2、消息体为 { code: "500", message:"Delete resource failed." } | 1、已删除的数据全部回滚; 2、设置HttpStatus为400或500; 3、消息体为 { code: "500", message:"Delete resource failed." } |
前端处理简单: var result = JSON.parse(response.data); if (result.code) { // 有错误: alert(result.message); } else { // 没有错误 } |
web中resultful代码json设置规范
最新推荐文章于 2024-02-03 13:15:52 发布