swagger2是一個非常好用的介面文件，在開發的過程中方便前後端介面的交接。

下面我們就來講講在使用java時，分別在SSM框架，以及springboot+mybatis框架中引入swagger2的方法。

一、在SSM框架中引入swagger2

需要加的maven依賴

1.在com.imooc.utils下建立一個swagger2的配置類

package com.imooc.utils;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration
 
;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import 
 
springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2 {
   
   @Bean
   public Docket createRestApi() {
      return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
            .apis(RequestHandlerSelectors.basePackage
 
("com.imooc.web")) //指明controller所在的包
            .paths(PathSelectors.any()).build();
   }
   /**
    * @Description: 構建 api文件的資訊
    */
   private ApiInfo apiInfo() {
      return new ApiInfoBuilder()
            // 設定頁面標題
            .title("短視訊後臺管理系統api介面文件")
            // 設定聯絡人
            .contact(new Contact("聯絡人姓名", "see more at..","郵箱"))
            // 描述
            .description("controller層介面如下")
            // 定義版本號
            .version("1.0").build();
   }
}

2.在springmvc.xml中進行配置

二、在springboot專案中引入swagger2

新增maven依賴

1.在com.imooc包下建立swagger2的配置類

package com.imooc;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2 {

/**
* @Description:swagger2的配置檔案，這裡可以配置swagger2的一些基本的內容，比如掃描的包等等
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
.apis(RequestHandlerSelectors.basePackage("com.imooc.controller"))
.paths(PathSelectors.any()).build();
}

/**
* @Description: 構建 api文件的資訊
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
// 設定頁面標題
.title("使用swagger2構建短視訊後端api介面文件")
// 設定聯絡人
.contact(new Contact("聯絡人姓名", "see more at..","聯絡人的電子郵箱 "))
// 描述
.description("controller層介面如下")
// 定義版本號
.version("1.0").build();
}

}

2.在springboot的啟動類中指明需要掃描的包，只要讓swagger2.java被掃描到即可

3.在springboot的WebMvcConfig類中配置允許靜態資源的訪問

============================================================================

通過上面的方法，我們就已經在SSM專案或者springboot專案中成功引入了swagger2 介面文件。

此時我們就可以通過 ip+埠/swagger-ui.html 來訪問介面文件，例如 http://localhost:8080/swagger-ui.html

====================================================================

在引入了swagger2之後，我們還需要加上一些註解，才能夠達到我們想要的效果，swagger2中常用註解的使用：

https://blog.csdn.net/ajklaclk/article/details/80736042