swagger2配置文件（swagger2 配置）



每一个成功人士的背后，必定曾经做出过勇敢而又孤独的决定。

放弃不难，但坚持很酷~

今天来说一下 Spring boot 如何集成 Swagger 2，虽然网上有很多这样的教程，但觉得还是应该自己梳理一下，这样对知识的掌握比较牢靠。另外文章中也有我在开发中遇到的问题及解决方法，统一记录下来。 真的比 postman 省心，对于前后端联调、测试、用户来说都很便利。

一、集成 Swagger 2

1、添加 pom.xml 文件依赖

2、添加 Swagger java 配置

分析上述配置，我们需要在 java 类上指明 @Configuration、@EnableSwagger2 注解。

另外还需要指定 controller 的包路径。如果需要隐藏 Swagger ui 上的 Models 模块，则需要上面的 uiConfig() 方法。

为了防止 @EnableMvc 把默认的静态资源路径覆盖，还需要上面的 addResourceHandlers() 方法。

紧接着，我们就可以启动项目了，Swagger 2 ui 地址为：http://ip:port/swagger-ui.html 。

二、Swagger 常用注解

参考博客：https://www.cnblogs.com/fengli9998/p/7921601.html

三、个人小结

1、Swagger ui 页面上的 body 里面的 Model

注解 @ApiModel 和 @ApiModelProperty 是作用在 javaBean 上的，可以起解释说明，是否必选，是否隐藏的作用。在 swagger-ui 页面上的体现形式如下图所示：

2、controller 层 swagger 相关注解

@Api、@ApiOperation、@ApiParam、@ApiIgnore、@ApiImplicitParams 都是作用在 controller 层的注解。如下图所示：

3、PO、DTO、VO 说明及使用

关于 java 中常见的对象类型简述（DO、BO、DTO、VO、AO、PO）可参考：https://blog.csdn.net/uestcyms/article/details/ 。

当有多个 requestparam 参数的时候，我们用 DTO 对象接收参数比较方便，用 DTO 对象来精准无冗余地接收请求参数。

可能这里有朋友会疑问，为什么不用 PO 来接收请求参数呢？

因为 PO 中可能存在冗余字段，如果用 PO 来接收参数的话，冗余字段也会在 Swagger ui 页面上显示，用户体验并不好，所以我们用 DTO 来接收请求参数。

同理，为了避免返回给前端的数据存在冗余字段（即不需要展示的字段），我们可以使用 VO 来接收数据返回给前端进行交互。

版权声明：

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如若内容造成侵权、违法违规、事实不符，请将相关资料发送至xkadmin@xkablog.com进行投诉反馈，一经查实，立即处理！

转载请注明出处，原文链接：https://www.xkablog.com/rfx/13227.html