Swagger筆記—Swagger3配置

@

目錄

• 什么是 Swagger？
• 依賴引入
  • springfox引入方式
  • knife4j引入方式
  • 引入美化bootstrap-UI
• 詳細配置
• swagger資源訪問路徑加入白名單
• 訪問路徑：
• 小技巧：

相關內容	地址
Swagger官方文檔	https://swagger.io/docs/specification/2-0/basic-structure/
Swagger常用注解	https://blog.csdn.net/weixin_42526326/article/details/119824857
Swagger2常用注解	https://blog.csdn.net/weixin_42526326/article/details/119963866
Swagger3常用注解	https://blog.csdn.net/weixin_42526326/article/details/119965092

什么是 Swagger？

Swagger是一組圍繞 OpenAPI 規范構建的開源工具，可幫助您設計、構建、記錄和使用 REST API。主要的 Swagger 工具包括：

Swagger Editor – 基於瀏覽器的編輯器，您可以在其中編寫 OpenAPI 規范。
Swagger UI – 將 OpenAPI 規范呈現為交互式 API 文檔。

swagger2於17年停止維護，現在最新的版本為 Swagger3（Open Api3）。

依賴引入

我們可以去 mvnrepository（maven中央倉庫） 搜索版本，但是建議不要用最新版

springfox引入方式

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

knife4j引入方式

<dependency>
	<groupId>com.github.xiaoymin</groupId>
	<artifactId>knife4j-spring-boot-starter</artifactId>
	<version>3.0.3</version>
</dependency>

引入美化bootstrap-UI

<!-- 引入swagger-bootstrap-ui包 -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.8.5</version>
</dependency>

詳細配置

配置文件加上@EnableOpenApi、@Configuration 會自動開啟配置，啟動類不需要加任何注解

package com.doctorcloud.pc.interceptor.config;

import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;

import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.*;
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;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

/**
 *
 * @author 
 */
@Configuration
@Profile({"dev","local"})
@EnableOpenApi
@EnableSwaggerBootstrapUI
public class SwaggerConfig {

    /**
     * 是否開啟swagger配置，生產環境需關閉
     */
/*    @Value("${swagger.enabled}")*/
    private boolean enable;

    /**
     * 創建API
     * http:IP:端口號/swagger-ui/index.html 原生地址
     * http:IP:端口號/doc.html bootStrap-UI地址
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30).pathMapping("/")
                // 用來創建該API的基本信息，展示在文檔的頁面中（自定義展示的信息）
                /*.enable(enable)*/
                .apiInfo(apiInfo())
                // 設置哪些接口暴露給Swagger展示
                .select()
                // 掃描所有有注解的api，用這種方式更靈活
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                // 掃描指定包中的swagger注解
                // .apis(RequestHandlerSelectors.basePackage("com.doctorcloud.product.web.controller"))
                // 掃描所有 .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.regex("(?!/ApiError.*).*"))
                .paths(PathSelectors.any())
                .build()
                // 支持的通訊協議集合
                .protocols(newHashSet("https", "http"))
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts());

    }

    /**
     * 支持的通訊協議集合
     * @param type1
     * @param type2
     * @return
     */
    private Set<String> newHashSet(String type1, String type2){
        Set<String> set = new HashSet<>();
        set.add(type1);
        set.add(type2);
        return set;
    }

    /**
     * 認證的安全上下文
     */
    private List<SecurityScheme> securitySchemes() {
        List<SecurityScheme> securitySchemes = new ArrayList<>();
        securitySchemes.add(new ApiKey("token", "token", "header"));
        return securitySchemes;
    }

    /**
     * 授權信息全局應用
     */
    private List<SecurityContext> securityContexts() {
        List<SecurityContext> securityContexts = new ArrayList<>();
        securityContexts.add(SecurityContext.builder()
                .securityReferences(defaultAuth())
                .forPaths(PathSelectors.any()).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("接口文檔")
                // 描述
                .description("描述")
                // 作者信息
                .contact(new Contact("doctorCloud", null, null))
                // 版本
                .version("版本號:V.1")
                //協議
                .license("The Apache License")
                //協議url
                .licenseUrl("http://www.baidu.com")
                .build();
    }
}

swagger資源訪問路徑加入白名單

- /swagger-ui/**
- /webjars/**
- /doc.html
- /swagger-resources/**
- /v3/**

訪問路徑：

http:IP:端口號/swagger-ui/index.html 原生地址
http:IP:端口號/doc.html bootStrap-UI地址

小技巧：

不建議使用swagger原生頁面設置權限，建議使用doc頁面設置token，搜索接口更方便(主要是好看)

之前有用swagger3，突然間接口文檔出參都顯示不了，不得已只得退回到swagger