swagger返回参数(swagger返回值)

swagger返回参数(swagger返回值)立个 Flag 每天写点东西 坚持下去 项目中通常定义一个返回对象 Result 对返回对象的说明可以通过 ApiResponse 进行说明如下 为每个类都指定精准但比较麻烦 可以通过统一配置的方式为每个请求附带默认的返回值说明 API 文档 SpringBoot 集成 knif4j UI 框架 knife4j 文档 pom 依赖

大家好,我是讯享网,很高兴认识大家。



立个Flag每天写点东西,坚持下去。

项目中通常定义一个返回对象Result,对返回对象的说明可以通过@ApiResponse进行说明如下,为每个类都指定精准但比较麻烦,可以通过统一配置的方式为每个请求附带默认的返回值说明。

 

讯享网
讯享网

API文档SpringBoot集成knif4j UI框架 knife4j 文档


讯享网

pom依赖

 

通过globalResponses来设置统一的Response返回业务编码

swagger配置文件 RequestHandlerSelectors.basePackage扫描路径 RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class) 方法上有ApiOperation的注解

讯享网

统一返回值枚举

ResponseCodeEnums.java

 

运行项目 访问localhost:8080/doc.html 查看文档

image.png

doc文档每个请求都会带有默认的code、desc,方便前端联调。

喜欢就点个赞鼓励下吧

小讯
上一篇 2025-04-26 17:07
下一篇 2025-04-18 11:44

相关推荐

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容,请联系我们,一经查实,本站将立刻删除。
如需转载请保留出处:https://51itzy.com/kjqy/179427.html