欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

SpringBoot項(xiàng)目集成Swagger和swagger-bootstrap-ui及常用注解解讀

 更新時(shí)間：2023年03月31日 16:51:09   作者：Yuhei001  
這篇文章主要介紹了SpringBoot項(xiàng)目集成Swagger和swagger-bootstrap-ui及常用注解解讀，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

一、前言

隨著互聯(lián)網(wǎng)項(xiàng)目前后端分離方式的流行，前端與后端交給不同的人員開(kāi)發(fā)，項(xiàng)目溝通成本也隨之提高。

主要表現(xiàn)在WebAPI接口的溝通，Swagger2 應(yīng)運(yùn)而生，它可以動(dòng)態(tài)生成Api接口文檔，降低溝通成本，促進(jìn)項(xiàng)目高效開(kāi)發(fā)。

下面討論Swagger2及swagger-bootstrap-ui在SpringBoot上的集成

二、SpringBoot項(xiàng)目集成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. 編寫(xiě)配置文件

可對(duì)照進(jìn)行相應(yīng)的修改

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

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

    //構(gòu)建 api文檔的詳細(xì)信息函數(shù)
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //頁(yè)面標(biāo)題
                .title("XXX API對(duì)接文檔")
                .description("XX API對(duì)接文檔") //描述
                //創(chuàng)建人
                .contact(new Contact("yuhei001", "https://blog.csdn.net/Yuhei0", "18616591658@163.com"))
                //版本號(hào)
                .version("1.0")
                //描述
                .description("API 描述")
                .build();
    }
}

3. 啟動(dòng)訪問(wèn)頁(yè)面

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

在這里插入圖片描述

三、SpringBoot項(xiàng)目集成swagger-bootstrap-ui

在步驟二的基礎(chǔ)上進(jìn)行如下操作

1.引入依賴

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

2.配置資源處理規(guī)則

未配置的情況下，有可能訪問(wèn)報(bào)error.9996。

實(shí)現(xiàn)WebMvcConfigurer接口，或者WebMvcConfigurationSupport(老版的SpringBoot)，實(shí)現(xiàn)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 報(bào)錯(cuò)
        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 報(bào)錯(cuò)
        registry.addResourceHandler("doc.html").addResourceLocations("classpath*:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath*:/META-INF/resources/webjars/");
    }
}

另外，也可以在啟動(dòng)類(lèi)上進(jìn)行實(shí)現(xiàn)重寫(xiě)

@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.啟動(dòng)訪問(wèn)頁(yè)面

訪問(wèn)http://127.0.0.1:10086/doc.html，相較swagger-ui.html來(lái)說(shuō)，此文檔更為清爽。

在這里插入圖片描述

四、Swagger常用注解介紹

swagger通過(guò)注解生成接口文檔，包括接口名、請(qǐng)求方法、參數(shù)、返回信息等等。

1.Swagger2Config中相關(guān)swagger注解

1.1 @EnableSwagger2 開(kāi)啟Swagger

作用于配置類(lèi)或啟動(dòng)類(lèi)

1.2 @EnableSwaggerBootstrapUI 開(kāi)啟SwaggerBootstrapUi增強(qiáng)功能

作用于配置類(lèi)或啟動(dòng)類(lèi)，如果不使用增強(qiáng)功能，可不開(kāi)啟。

2.controller中相關(guān)swagger注解

2.1 @Api：修飾整個(gè)類(lèi)，描述Controller的作用

value和tags均為說(shuō)明，可用tags代替value

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

2.2 @ApiOperation() 用于方法；表示一個(gè)http請(qǐng)求的操作

@ApiOperation(value = "信息員保存(注冊(cè))/更新", tags = {"信息員保存"}, notes = "messenger desc")

2.3 @ApiParam 用于方法，參數(shù)，字段說(shuō)明；表示對(duì)參數(shù)的添加元數(shù)據(jù)（說(shuō)明或是否必填等）

適用于單個(gè)參數(shù)

@ApiParam(name="sdMessengerInfo",value="參數(shù)描述",required=true)

2.4 請(qǐng)求參數(shù)注解，可進(jìn)行組合

  • @ApiImplicitParams 用于方法，包含多個(gè) @ApiImplicitParam
  • @ApiImplicitParam 用于方法，表示單獨(dú)的請(qǐng)求參數(shù)

適用于對(duì)多個(gè)參數(shù)進(jìn)行描述

示例：

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

注意，當(dāng)同時(shí)存在@ApiParam和@ApiImplicitParam時(shí)，以@ApiImplicitParam的描述為準(zhǔn)。

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

2.6 響應(yīng)配置

  • @ApiResponses
  • @ApiResponse
// 單獨(dú)配置
@ApiResponse(code = 400, message = "Invalid user supplied")
// 組合使用
@ApiResponses({ @ApiResponse(code = 400, message = "Invalid Order") })

2.7 @ResponseHeader 響應(yīng)頭設(shè)置

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

3.Model中相關(guān)swagger注解

3.1 @ApiModel 用于類(lèi) ；表示對(duì)類(lèi)進(jìn)行說(shuō)明，用于參數(shù)用實(shí)體類(lèi)接收。

@ApiModel(value = "demo", description = "對(duì)象描述")

一般value和desc可以省略不寫(xiě)

3.2 @ApiModelProperty 用于方法，字段； 表示對(duì)model屬性的說(shuō)明或者數(shù)據(jù)操作更改

@ApiModelProperty(value = "用戶id",name = "openid2",dataType = "String", required = true, hidden = true)
  • value–字段說(shuō)明
  • name–重寫(xiě)屬性名字
  • dataType–重寫(xiě)屬性類(lèi)型
  • required–是否必填
  • example–舉例說(shuō)明
  • hidden–隱藏

一般只對(duì)value，required進(jìn)行標(biāo)示。

總結(jié)

以上，即為SpringBoot集成Swagger、swagger-bootstrap-ui以及Swagger常用注解相關(guān)介紹。

僅為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

相關(guān)文章

  • Jmeter結(jié)構(gòu)體系及運(yùn)行原理順序解析

    Jmeter結(jié)構(gòu)體系及運(yùn)行原理順序解析

    這篇文章主要介紹了Jmeter結(jié)構(gòu)體系及運(yùn)行原理順序解析,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
    2020-09-09
  • Java注解Annotaton詳解

    Java注解Annotaton詳解

    Java 注解（Annotation）又稱 Java 標(biāo)注，是 JDK5.0 引入的一種注釋機(jī)制，文中給大家介紹了三種基本的Annotaton，本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友參考下吧
    2022-05-05
  • Java關(guān)鍵字synchronized基本使用詳解

    Java關(guān)鍵字synchronized基本使用詳解

    這篇文章主要給大家介紹了關(guān)于Java關(guān)鍵字synchronized基本使用的相關(guān)資料,synchronized可以用來(lái)同步靜態(tài)和非靜態(tài)方法,文中通過(guò)代碼介紹的非常詳細(xì),需要的朋友可以參考下
    2024-01-01
  • 精通Java List 按字段提取對(duì)象

    精通Java List 按字段提取對(duì)象

    這篇文章主要介紹了精通Java List 按字段提取對(duì)象的相關(guān)資料,需要的朋友可以參考下
    2023-11-11
  • 利用Thumbnailator輕松實(shí)現(xiàn)圖片縮放、旋轉(zhuǎn)與加水印

    利用Thumbnailator輕松實(shí)現(xiàn)圖片縮放、旋轉(zhuǎn)與加水印

    java開(kāi)發(fā)中經(jīng)常遇到對(duì)圖片的處理，JDK中也提供了對(duì)應(yīng)的工具類(lèi)，不過(guò)處理起來(lái)很麻煩，Thumbnailator是一個(gè)優(yōu)秀的圖片處理的開(kāi)源Java類(lèi)庫(kù),處理效果遠(yuǎn)比Java API的好，這篇文章主要介紹了利用Thumbnailator如何輕松的實(shí)現(xiàn)圖片縮放、旋轉(zhuǎn)與加水印，需要的朋友可以參考下
    2017-01-01
  • Java中實(shí)現(xiàn)多線程的幾種方式總結(jié)

    Java中實(shí)現(xiàn)多線程的幾種方式總結(jié)

    文章介紹了三種創(chuàng)建線程的方式：繼承Thread類(lèi)、實(shí)現(xiàn)Runnable接口和實(shí)現(xiàn)Callable接口,并比較了它們之間的區(qū)別和優(yōu)缺點(diǎn)
    2025-01-01
  • maven配置文件pom增加變量取版本號(hào)方式

    maven配置文件pom增加變量取版本號(hào)方式

    這篇文章主要介紹了maven配置文件pom增加變量取版本號(hào)方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教
    2021-12-12
  • Spring Boot webflux使用方法解析

    Spring Boot webflux使用方法解析

    這篇文章主要介紹了Spring Boot webflux使用方法解析,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
    2020-03-03
  • JavaWeb中文編碼問(wèn)題實(shí)例講解

    JavaWeb中文編碼問(wèn)題實(shí)例講解

    在本篇文章里小編給大家整理的是關(guān)于JavaWeb中文編碼問(wèn)題方法的相關(guān)知識(shí)點(diǎn)內(nèi)容，需要的朋友們參考下
    2019-09-09
  • Mybatis映射文件詳解之mapper.xml文件

    Mybatis映射文件詳解之mapper.xml文件

    本文詳細(xì)介紹了Mybatis映射文件的結(jié)構(gòu)、標(biāo)簽和使用方法,包括mapper元素、標(biāo)簽的主要屬性如id、parameterType、resultType以及動(dòng)態(tài)SQL和結(jié)果映射的使用,通過(guò)映射文件,可以將數(shù)據(jù)庫(kù)表與Java對(duì)象映射,支持查詢、插入、更新、刪除等操作,提高了SQL語(yǔ)句的靈活性和可重用性
    2024-09-09

最新評(píng)論