SpringBoot專案整合Swagger和swagger-bootstrap-ui及常用註解解讀

2023-04-02 06:02:29

一、前言

隨著網際網路專案前後端分離方式的流行，前端與後端交給不同的人員開發，專案溝通成本也隨之提高。

主要表現在WebAPI介面的溝通，Swagger2 應運而生，它可以動態生成Api介面檔案，降低溝通成本，促進專案高效開發。

下面討論Swagger2及swagger-bootstrap-ui在SpringBoot上的整合

二、SpringBoot專案整合swagger

1. 引入依賴

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.8.0</version>
        </dependency>

2. 編寫組態檔

可對照進行相應的修改

@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
@Profile({"dev","test"})
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("") //指定分組，對應(/v2/api-docs?group=)
                .pathMapping("") //base地址，最終會拼接Controller中的地址
                .apiInfo(apiInfo())
                .select()
                //為當前包路徑
				// .apis(RequestHandlerSelectors.any())
                .apis(RequestHandlerSelectors.basePackage("com.riskeys.sd.custom"))
                .paths(PathSelectors.any())
                .build();
    }

    //構建 api檔案的詳細資訊函數
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //頁面標題
                .title("XXX API對接檔案")
                .description("XX API對接檔案") //描述
                //建立人
                .contact(new Contact("yuhei001", "https://blog.csdn.net/Yuhei0", "18616591658@163.com"))
                //版本號
                .version("1.0")
                //描述
                .description("API 描述")
                .build();
    }
}

3. 啟動存取頁面

http://127.0.0.1:10086/swagger-ui.html

三、SpringBoot專案整合swagger-bootstrap-ui

在步驟二的基礎上進行如下操作

1.引入依賴

        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

2.設定資源處理規則

未設定的情況下，有可能存取報error.9996。

實現WebMvcConfigurer介面，或者WebMvcConfigurationSupport(老版的SpringBoot)，實現addResourceHandlers方法，加上如下所示程式碼即可。

@Configuration
public class AppWebConfig extends WebMvcConfigurationSupport{

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        // 解決 doc.html 404 報錯
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

}

或者

@Configuration
public class AppWebConfig extends WebMvcConfigurationSupport{
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        // 解決 doc.html 404 報錯
        registry.addResourceHandler("doc.html").addResourceLocations("classpath*:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath*:/META-INF/resources/webjars/");
    }
}

另外，也可以在啟動類上進行實現重寫

@SpringBootApplication
public class XXXApplication  implements WebMvcConfigurer{
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("doc.html").addResourceLocations("classpath*:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath*:/META-INF/resources/webjars/");
    }
}

3.啟動存取頁面

存取http://127.0.0.1:10086/doc.html，相較swagger-ui.html來說，此檔案更為清爽。

四、Swagger常用註解介紹

swagger通過註解生成介面檔案，包括介面名、請求方法、引數、返回資訊等等。

1.Swagger2Config中相關swagger註解

1.1 @EnableSwagger2 開啟Swagger

作用於設定類或啟動類

1.2 @EnableSwaggerBootstrapUI 開啟SwaggerBootstrapUi增強功能

作用於設定類或啟動類，如果不使用增強功能，可不開啟。

2.controller中相關swagger註解

2.1 @Api：修飾整個類，描述Controller的作用

value和tags均為說明，可用tags代替value

@Api(value = "保險公司列表查詢", tags = {"保險公司列表查詢"})

2.2 @ApiOperation() 用於方法；表示一個http請求的操作

@ApiOperation(value = "資訊員儲存(註冊)/更新", tags = {"資訊員儲存"}, notes = "messenger desc")

2.3 @ApiParam 用於方法，引數，欄位說明；表示對引數的新增後設資料（說明或是否必填等）

適用於單個引數

@ApiParam(name="sdMessengerInfo",value="引數描述",required=true)

2.4 請求引數註解，可進行組合

@ApiImplicitParams 用於方法，包含多個 @ApiImplicitParam
@ApiImplicitParam 用於方法，表示單獨的請求引數

適用於對多個引數進行描述

範例：

// 組合使用
@ApiImplicitParams ({
    @ApiImplicitParam(name = "id", value = "引數中文描述", required = true)
})
// 單獨使用
@ApiImplicitParam(paramType="query", name="id", dataType="String", required=true, value="引數描述")

注意，當同時存在@ApiParam和@ApiImplicitParam時，以@ApiImplicitParam的描述為準。

2.5 @ApiIgnore() 用於類或者方法上，可以不被swagger顯示在頁面上 ,使用較少。

2.6 響應設定

@ApiResponses
@ApiResponse

// 單獨設定
@ApiResponse(code = 400, message = "Invalid user supplied")
// 組合使用
@ApiResponses({ @ApiResponse(code = 400, message = "Invalid Order") })

2.7 @ResponseHeader 響應頭設定

@ResponseHeader(name="head1",description="response head conf")

3.Model中相關swagger註解

3.1 @ApiModel 用於類；表示對類進行說明，用於引數用實體類接收。

@ApiModel(value = "demo", description = "物件描述")

一般value和desc可以省略不寫

3.2 @ApiModelProperty 用於方法，欄位；表示對model屬性的說明或者資料操作更改

@ApiModelProperty(value = "使用者id",name = "openid2",dataType = "String", required = true, hidden = true)

value–欄位說明
name–重寫屬性名字
dataType–重寫屬性型別
required–是否必填
example–舉例說明
hidden–隱藏

一般只對value，required進行標示。

總結

以上，即為SpringBoot整合Swagger、swagger-bootstrap-ui以及Swagger常用註解相關介紹。

僅為個人經驗，希望能給大家一個參考，也希望大家多多支援it145.com。