网站首页 > 技术文章 正文
上一篇大家看到了使用swagger展现Restful接口的便利性。
大家同样可以看到Restful接口返回给前端的结果是将Controller层方法的返回值直接返给前端,这样做可能会有以下缺陷:
- 前台需要根据http的状态判断请求是否正确,无法从请求层面区分是业务错误还是网络错误
- 前端对http请求的知识依赖增大
- 对自定义的错误请求需要和业务数据混合在一起(数据混合或者变量公用,等等)
所以一般情况下,开发框架层面会提供一个标准的请求返回格式。最基本的这种返回格式由一下几个属性组成:
- code,返回码,用于标识出当前请求的状态
- message,返回消息,用于补充说明当前请求的状态
- success,成功与否的标识为,用于快速判断请求是否发生业务处理错误
- data,返回数据,承载了成功后的正常数据,或者异常时的数据(降级数据,补偿数据,异常信息,等等)。
代码其实也很简单,可以直接参考:
https://github.com/dean2015/chinacat-boot-model
实际使用时,直接使用controller层返回RestResponse即可。
在之前的chinacat-samples工程的chinacat-sample-rest模块中的controller里,添加如下红框种的代码
运行应用,打开swagger界面(http://your-IP:your-port/swagger-ui.html)
执行 /hello1的Restful接口,得到的结果将按照下面格式返回
样例代码参考:
https://github.com/dean2015/chinacat-samples
猜你喜欢
- 2024-09-30 快速搭建 SpringCloud 微服务开发环境的脚手架
- 2024-09-30 基于 SpringBoot 的 Api 服务器脚手架
- 2024-09-30 Springboot+Mysql在线拍卖竞价拍卖竞拍系统源码附带运行视频教程
- 2024-09-30 Springboot+Mysql舞蹈课程在线预约系统源码附带视频运行教程
- 2024-09-30 基于Spring Boot的快速开发脚手架的开发(6)
- 2024-09-30 史上最详细的SpringBoot教程 springboot步骤
- 2024-09-30 微服务脚手架zuihou-admin-cloud 微服务框架选型
- 2024-09-30 SpringBoot+Mysql羽毛球馆在线预约系统源码+运行视频教程
- 2024-09-30 【学】alibaba initializr 生成脚手架
- 2024-09-30 以SpringBoot2为基础,打造一个快速开发的Web应用脚手架Crown
你 发表评论:
欢迎- 最近发表
- 标签列表
-
- oraclesql优化 (66)
- 类的加载机制 (75)
- feignclient (62)
- 一致性hash算法 (71)
- dockfile (66)
- 锁机制 (57)
- javaresponse (60)
- 查看hive版本 (59)
- phpworkerman (57)
- spark算子 (58)
- vue双向绑定的原理 (68)
- springbootget请求 (58)
- docker网络三种模式 (67)
- spring控制反转 (71)
- data:image/jpeg (69)
- base64 (69)
- java分页 (64)
- kibanadocker (60)
- qabstracttablemodel (62)
- java生成pdf文件 (69)
- deletelater (62)
- com.aspose.words (58)
- android.mk (62)
- qopengl (73)
- epoch_millis (61)
本文暂时没有评论,来添加一个吧(●'◡'●)