swagger2 配置（swagger2 配置 spring项目）



前面介绍了如何Spring Boot 快速打造Restful API 接口，也介绍了如何优雅的实现 Api 版本控制。

在实际项目中，Api 接口系统对接过程中，Api 接口文档是非常重要的文档。一般是设计完成之后，同时编写Api 接口文档，然后将接口文档发给相关人员，于是大家就按照该文档开发、集成并最终上线。但是，这是一种非常理想的状态，实际开发中，接口不断变化，接口文档也必须保持更新，这是一个非常麻烦的过程！为了解决这些问题，Swagger2 应运而生。接下来，就和大伙聊一聊 Spring Boot 如何整合Swagger2，使用Swagger2构建 RESTful API文档。

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。是世界上最流行的 API 表达工具 。我们知道，RESTful API 可能要面对多个开发人员或多个开发团队：IOS开发、Android开发或是Web前端开发等。为了减少与其他团队平时开发期间的频繁沟通成本，一般我们会创建一份API文档来记录所有接口细节，但是api 接口文档存在以下问题：

为了解决这些问题，Swagger2 应运而生。它可以轻松的整合到Spring Boot 中，自动生成强大的 RESTful API文档。这样既可以减少我们创建文档的工作量，同时说明内容又整合入实现代码中，让维护文档和修改代码整合为一体，可以让我们在修改代码逻辑的同时方便的修改文档说明。另外Swagger2也提供了完整的测试页面，来调试每个API 接口。

下面就以SpringBoot中集成Swagger为例做介绍说明Swagger2 的功能和作用。

Spring Boot 集成 Swagger 2很简单，首先新建一个 SpringBoot 项目，这里就不重新创建项目，直接使用之前的rest 测试项目。然后引入依赖并做基础配置即可：

1、配置Swagger2的依赖

在pom.xml 配置文件中，增加Swagger 2 的相关依赖，具体如下：

注意，Swagger 2 的版本号和 spring boot的版本号有些不匹配，最开始用2.2的版本和spring boot 的版本还不匹配，后来把 Swagger 2 换成了2.8。

2、创建Swagger 2配置类

在com.weiz.config 包中，增加Swagger 2 的配置类，SwaggerConfig 类，具体代码如下：

说明：@Configuration 注解让Spring boot来加载该类配置，@EnableSwagger2注解启用Swagger 2，通过配置一个Docket Bean，配置映射路径和要扫描的接口的位置。apiInfo，主要配置一下Swagger2文档网站的信息，例如网站的title、网站的描述、使用的协议等等。

注意：

　　1、basePackage 可以在SwaggerConfig 里面配置 com.weiz.controller，也可以在启动器里面 ComponentScan 配置。

　　2、需要在Swaggerconfig 中配置Swagger 的url 映射。

上面配置完成之后，接下来需要在api 接口上增加内容说明。这里方便起见，就直接在之前的UserController 中，增加相应的接口内容说明，代码如下所示：

说明：

　　1、@Api注解，用来给整个controller 增加说明。

　　2、@ApiOperation注解，用来给各个API 方法增加说明。

　　3、@ApiImplicitParams、@ApiImplicitParam注解，用来给参数增加说明。

　　4、Swagger 还有用于对象参数的注解，对象参数的描述也可以放在实体类中。这里不细说，大家可以自行研究。

以上，就把Spring Boot 如何整合Swagger2，使用Swagger2构建 RESTful API文档 介绍完了。实现还是比较简单的，但是还是需要理解里面的相关注解的用法。

版权声明：

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

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