Restful风格

Restful风格

以告警管理(WarningController)增删改查为例子
接口 请求方式 描述
http://127.0.0.1/warnings?current=0&pageSize=10 GET 分页查询所有列表
http://127.0.0.1/warnings/123 GET 根据ID查询告警信息
http://127.0.0.1/warnings POST 新增告警信息
http://127.0.0.1/warnings/123 PUT 根据更新告警信息
http://127.0.0.1/warnings/123 DELETE 根据更新告警信息
http://127.0.0.1/warnings/start/123 PUT 启用告警
http://127.0.0.1/warnings/stop/123 PUT 停用告警

返回前端统一风格

返回码 代码 描述
200 ResponseEntity.ok(T) 正常包含返回数据(例:分页获取,根据id查询接口)
201 ResponseEntity.status(HttpStatus.CREATED).build() 新增成功(例:新增成功接口)
204 ResponseEntity.status(HttpStatus.NO_CONTENT).build() 正常不包含内容(例:删除成功,更新成功接口)
401 ResponseEntity.status(HttpStatus.UNAUTHORIZED).body(null) 没有权限(例:当前用户没访问资源权限)
404 ResponseEntity.status(HttpStatus.NOT_FOUND).body(null) 资源不存在(例:根据id查不到当前实例)
500 ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(null) 服务器错误(例:出现系统异常)

返回前端的分页数据格式

实例类为:com.deepexi.ai.business.query.domain.dto.PageInfo
  • current:当前页码
  • pageSize:每页的数量
  • total:为总页数
  • list:为数据内容
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。