Spring-Boot-2-x使用Swagger2构建API文档及跳坑（二）

前言

上一篇文章介绍了前后端分离框架，如何设计一个简单易行的API文档，今天我们就介绍一下如何在SpringBoot2.x项目中应用此Swagger2框架，在使用过程中我们需要注意哪些方面。

开始项目

首先，我们需要一个带有一些Rest Controller的Spring Boot应用程序，我使用了SpringFox 2.9.2和Spring Boot 2.1.12.RELEASE。

添加Swagger2依赖

在pom.xml中加入Swagger2的依赖

创建Swagger2配置类

在项目的配置包下面创建Swagger2的配置类Swagger2Config

配置信息如下

如上代码所示，通过**@Configuration注解，让Spring来加载该类配置**。

• @ EnableSwagger2支持Swagger 2的SpringFox支持。

• DocumentationType.SWAGGER_2告诉Docketbean我们正在使用Swagger规范的版本2。

• **apiInfo()**用来创建该Api的基本信息（这些基本信息会展现在文档页面中）。

• select()创建一个构建器，用于定义哪些控制器及其生成的文档中应包含哪些方法。

• apis()定义要包含的类（控制器和模型类）。这里我们包括所有这些，但您可以通过基础包，类注释等来限制它们。

SpringFox会将其检测为文档生成源。Controller和Model类。您可以在Docket配置中轻松配置它。我们可以使用.apis（RequestHandlerSelectors.any（）来包含所有类；当然我们也可以缩小到我们的基础包<