引入 Swagger2 相关依赖

  1.     <!-- 添加swagger2相关功能 -->
  2.        <dependency>
  3.            <groupId>io.springfox</groupId>
  4.            <artifactId>springfox-swagger2</artifactId>
  5.            <version>2.9.2</version>
  6.        </dependency>
  7.        <!-- 添加swagger-ui相关功能 -->
  8.        <dependency>
  9.            <groupId>io.springfox</groupId>
  10.            <artifactId>springfox-swagger-ui</artifactId>
  11.            <version>2.9.2</version>
  12.        </dependency>

启用并配置 Swagger2 功能

我们添加一个配置类，专门用于配置 Swagger2 相关功能，这样比较清晰点。通过 @EnableSwagger2 注解开启 Swagger2 功能，通过 @Bean 标注的方法将对 Swagger2 功能的设置放入容器。

  1. @Configuration // 告诉Spring容器，这个类是一个配置类
  2. @EnableSwagger2 // 启用Swagger2功能
  3. public class Swagger2Config {
  4.     /**
  5.      * 配置Swagger2相关的bean
  6.      */
  7.     @Bean
  8.     public Docket createRestApi() {
  9.         return new Docket(DocumentationType.SWAGGER_2)
  10.                 .apiInfo(apiInfo())
  11.                 .select()
  12.                 .apis(RequestHandlerSelectors.basePackage("com"))// com包下所有API都交给Swagger2管理
  13.                 .paths(PathSelectors.any()).build();
  14.     }
  16.     /**
  17.      * 此处主要是API文档页面显示信息
  18.      */
  19.     private ApiInfo apiInfo() {
  20.         return new ApiInfoBuilder()
  21.                 .title("演示项目API") // 标题
  22.                 .description("学习Swagger2的演示项目") // 描述
  23.                 .termsOfServiceUrl("http://127.0.0.1:8080") // 服务网址，一般写公司地址
  24.                 .version("1.0") // 版本
  25.                 .build();
  26.     }
  27. }

访问http://127.0.0.1:8080/swagger-ui.html