spring boot集成swagger bootstrap ui

新建spring boot項(xiàng)目题禀,并添加swagger相關(guān)依賴,完整pom如下:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.2</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>boot-swagger</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>boot-swagger</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!--swagger相關(guān)依賴start-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>
        <!--swagger相關(guān)依賴end-->
        <!--spring-data相關(guān)依賴-->
        <dependency>
            <groupId>org.springframework.data</groupId>
            <artifactId>spring-data-commons</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

新建swagger配置類

package com.example.bootswagger.config;

import com.fasterxml.classmate.TypeResolver;
import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Getter;
import lombok.Setter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.Ordered;
import org.springframework.data.domain.Pageable;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.AlternateTypeRule;
import springfox.documentation.schema.AlternateTypeRuleConvention;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * @author liujy
 * @description swagger配置類
 * @since 2021-01-18 09:54
 */
@EnableSwagger2
@EnableSwaggerBootstrapUI
@Configuration
class SwaggerBootstrapUIConfiguration {
    public static final String basePackage = "com.example.bootswagger";
    public static final String title = "spring boot整合swagger";
    public static final String des = "spring boot整合swagger";

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 設(shè)置包掃描路徑
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.any())
                .build();
    }

    @Bean
    public Docket createWebApi() {
        // 創(chuàng)建 Docket 對象
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.ant("/**/w/**"))
                .build().groupName("Web端API接口文檔");
        return docket;
    }

    @Bean
    public Docket createMobileApi() {
        // 創(chuàng)建 Docket 對象
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.ant("/**/m/**"))
                .build().groupName("Mobile端API接口文檔");
        return docket;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(title)
                .description(des)
                .version("1.0")
                .build();
    }
    
    /**
     * 將Pageable轉(zhuǎn)換展示在swagger中
     */
    @Bean
    public AlternateTypeRuleConvention pageableConvention(final TypeResolver resolver) {
        return new AlternateTypeRuleConvention() {
            @Override
            public int getOrder() {
                return Ordered.HIGHEST_PRECEDENCE;
            }

            @Override
            public List<AlternateTypeRule> rules() {
                List<AlternateTypeRule> list = new ArrayList<>();
                list.add(new AlternateTypeRule(resolver.resolve(Pageable.class), resolver.resolve(Page.class)));
                return list;
            }
        };
    }

    @ApiModel
    @Getter
    @Setter
    private class Page {
        @ApiModelProperty(value = "請求分頁頁碼 (0..N)", example = "0")
        private Integer page = 0;

        @ApiModelProperty(value = "每頁的記錄數(shù)", example = "10")
        private Integer size = 10;

        @ApiModelProperty(value = "排序格式: property(,asc|desc). 默認(rèn)是升序 asc. 支持多個(gè)排序條件", example = "createdDate,desc")
        private List<String> sort;
    }
}

controller測試類

package com.example.bootswagger.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.web.PageableDefault;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author liujy
 * @description web測試接口
 * @since 2021-01-18 10:05
 */
@RestController
// 匹配swagger配置類中**/w/**的path配置
@RequestMapping(value = "/web/w")
@Api(tags = {"測試模塊-測試控制器"})
public class TestWebController {

    @ApiOperation("這是一個(gè)web接口")
    @GetMapping("/t1")
    public String test(@PageableDefault(value = 10, sort = {"createDate"}, direction = Sort.Direction.DESC) final Pageable pageable) {
        return "web interface success";
    }
}
package com.example.bootswagger.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author liujy
 * @description mobile測試接口
 * @since 2021-01-18 11:31
 */
@RestController
// 匹配swagger配置類中**/w/**的path配置
@RequestMapping(value = "/app/m")
@Api(tags = {"測試模塊-測試控制器"})
public class TestAppController {

    @ApiOperation("這是一個(gè)mobile接口")
    @GetMapping("/t1")
    public String test() {
        return "mobile interface success";
    }
}

項(xiàng)目包結(jié)構(gòu)如圖:

項(xiàng)目包結(jié)構(gòu)

啟動項(xiàng)目肮疗,訪問http://ip:port/doc.html或者http://ip:port/swagger-ui.html(注意:http://ip:port/swagger-ui.html可用來測試文件下載)
訪問http://ip:port/swagger-ui.html

訪問http://ip:port/doc.html

如圖丹锹,web測試接口中所需的page信息也已經(jīng)生效:
page信息

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末猿妈,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子故河,更是在濱河造成了極大的恐慌吱韭,老刑警劉巖,帶你破解...
    沈念sama閱讀 211,884評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件鱼的,死亡現(xiàn)場離奇詭異理盆,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)凑阶,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,347評論 3 385
  • 文/潘曉璐 我一進(jìn)店門熏挎,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人晌砾,你說我怎么就攤上這事坎拐。” “怎么了养匈?”我有些...
    開封第一講書人閱讀 157,435評論 0 348
  • 文/不壞的土叔 我叫張陵哼勇,是天一觀的道長。 經(jīng)常有香客問我呕乎,道長积担,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,509評論 1 284
  • 正文 為了忘掉前任猬仁,我火速辦了婚禮帝璧,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘湿刽。我一直安慰自己的烁,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,611評論 6 386
  • 文/花漫 我一把揭開白布诈闺。 她就那樣靜靜地躺著渴庆,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上襟雷,一...
    開封第一講書人閱讀 49,837評論 1 290
  • 那天刃滓,我揣著相機(jī)與錄音,去河邊找鬼耸弄。 笑死咧虎,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的计呈。 我是一名探鬼主播老客,決...
    沈念sama閱讀 38,987評論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼震叮!你這毒婦竟也來了胧砰?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,730評論 0 267
  • 序言:老撾萬榮一對情侶失蹤苇瓣,失蹤者是張志新(化名)和其女友劉穎尉间,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體击罪,經(jīng)...
    沈念sama閱讀 44,194評論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡哲嘲,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,525評論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了媳禁。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片眠副。...
    茶點(diǎn)故事閱讀 38,664評論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖竣稽,靈堂內(nèi)的尸體忽然破棺而出囱怕,到底是詐尸還是另有隱情,我是刑警寧澤毫别,帶...
    沈念sama閱讀 34,334評論 4 330
  • 正文 年R本政府宣布娃弓,位于F島的核電站,受9級特大地震影響岛宦,放射性物質(zhì)發(fā)生泄漏台丛。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,944評論 3 313
  • 文/蒙蒙 一砾肺、第九天 我趴在偏房一處隱蔽的房頂上張望挽霉。 院中可真熱鬧,春花似錦变汪、人聲如沸侠坎。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,764評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽硅蹦。三九已至,卻和暖如春闷煤,著一層夾襖步出監(jiān)牢的瞬間童芹,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,997評論 1 266
  • 我被黑心中介騙來泰國打工鲤拿, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留假褪,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,389評論 2 360
  • 正文 我出身青樓近顷,卻偏偏與公主長得像生音,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子窒升,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,554評論 2 349

推薦閱讀更多精彩內(nèi)容