springboot集成swagger-bootstrap-ui實現Authorize 功能

用Swagger測試接口的時候請求頭需要攜帶token參數，swagger-bootstrap-ui就爲我們提供了這樣的功能。

swagger-bootstrap-ui 相對swagger使用更好點。

1、引入jar

<!-- swagger2-->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
   <exclusions>
       <exclusion>
           <groupId>io.swagger</groupId>
           <artifactId>swagger-annotations</artifactId>
       </exclusion>
       <exclusion>
           <groupId>io.swagger</groupId>
           <artifactId>swagger-models</artifactId>
       </exclusion>
   </exclusions>
</dependency>

<!--防止進入swagger頁面報類型轉換錯誤，排除2.9.2中的引用，手動增加1.5.21版本-->
 <dependency>
      <groupId>io.swagger</groupId>
      <artifactId>swagger-annotations</artifactId>
      <version>1.5.21</version>
 </dependency>
      
<dependency>
     <groupId>io.swagger</groupId>
     <artifactId>swagger-models</artifactId>
     <version>1.5.21</version>
</dependency>
    
<!-- swagger2-UI-->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.9.2</version>
</dependency>
<!-- swagger-bootstrap-ui-->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.6</version>
</dependency>

2、編寫SwaggerConfig 配置類

import java.util.ArrayList;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import io.swagger.annotations.ApiOperation;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.ApiKey;
import springfox.documentation.service.AuthorizationScope;
import springfox.documentation.service.Contact;
import springfox.documentation.service.SecurityReference;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Swagger2的接口配置
 *
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig{
    /**
     * 創建API
     */
    @Bean
    public Docket createRestApi()
    {
        return new Docket(DocumentationType.SWAGGER_2)
                // 是否啓用Swagger ,true 開啓， false 關閉
                .enable(true) 
               // .pathMapping("/test-api")
                // 用來創建該API的基本信息，展示在文檔的頁面中（自定義展示的信息）
                .apiInfo(apiInfo())
                // 設置哪些接口暴露給Swagger展示
                .select()
                // 掃描所有有註解的api，用這種方式更靈活
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                // 掃描所有 .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build()
                /* 設置安全模式，swagger可以設置訪問token */
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts());
    }

    /**
     * 安全模式，這裏指定token通過Authorization頭請求頭傳遞
     */
    private List<ApiKey> securitySchemes()
    {
        List<ApiKey> apiKeyList = new ArrayList<ApiKey>();
        apiKeyList.add(new ApiKey("Authorization", "Authorization", "header"));
        return apiKeyList;
    }

    /**
     * 安全上下文
     */
    private List<SecurityContext> securityContexts()
    {
        List<SecurityContext> securityContexts = new ArrayList<>();
        securityContexts.add(
                SecurityContext.builder()
                        .securityReferences(defaultAuth())
                        .forPaths(PathSelectors.regex("^(?!auth).*$"))
                        .build());
        return securityContexts;
    }

    /**
     * 默認的安全上引用
     */
    private List<SecurityReference> defaultAuth()
    {
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        List<SecurityReference> securityReferences = new ArrayList<>();
        securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
        return securityReferences;
    }

    /**
     * 添加摘要信息
     */
    private ApiInfo apiInfo()
    {
        // 用ApiInfoBuilder進行定製
        return new ApiInfoBuilder()
                // 設置標題
                .title("標題：xxxxxx接口API")
                // 描述
                .description("描述：xxxxAPI文檔")
                // 作者信息
                .contact(new Contact(TEST, null, null))
                // 版本
                .version("版本號:2.2.0" )
                .build();
    }
}

3、在springboot啓動類添加 兩個註解 @EnableSwagger2  和 @EnableSwaggerBootstrapUI

@SpringBootApplication(exclude = { DataSourceAutoConfiguration.class })
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class RuoYiApplication {
    public static void main(String[] args)
    {
        SpringApplication.run(RuoYiApplication.class, args);
   
    }
}

4、在controller編寫接口

RestController
@RequestMapping("/content/search")
@Api(value = "es測試接口", tags = {"es測試相關的接口"})
public class ItemController extends BaseController {

    @Autowired
    private ItemService itemService;

    @ApiOperation(value = "添加ES測試接口",notes = "添加ES測試接口",httpMethod = "GET")
    @GetMapping(value = "/add")
    public AjaxResult add( ){
        ItemBean itemBean = new ItemBean();
        itemBean.setId((long) 1233456789);
        itemBean.setTitle("Ik分詞");
        itemBean.setCategory("文件");
        itemBean.setBrand("smart");
        itemBean.setPrice(1.1);
        itemBean.setImage("www.baidu.com");
        itemBean.setContent("正在學習 elasticsearch");
        itemService.insertData(itemBean);
        return  AjaxResult.success();
    }

 

效果圖：