最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

springBoot詳解集成Swagger流程

 更新時(shí)間:2022年06月28日 08:48:57   作者:奔走的王木木Sir  
Swagger是一個(gè)規(guī)范和完整的框架,用于生成、描述、調(diào)用和可視化?Restful?風(fēng)格的?Web?服務(wù)??傮w目標(biāo)是使客戶(hù)端和文件系統(tǒng)作為服務(wù)器以同樣的速度來(lái)更新。文件的方法、參數(shù)和模型緊密集成到服務(wù)器端的代碼,允許API來(lái)始終保持同步

目標(biāo):

  • 了解Swagger的作用和概念
  • 了解前后端分離
  • 在springBoot中集成Swagger

Swagger簡(jiǎn)介

前后端分離

VUE+springBoot

  • 后端 :后端控制層、服務(wù)層、數(shù)據(jù)訪問(wèn)層
  • 前端 :前端控制層、視圖層
  • 前后端通過(guò)API進(jìn)行交互
  • 前后端相對(duì)獨(dú)立,松耦合
  • 可以部署在不同的服務(wù)器上

產(chǎn)生的問(wèn)題

前后端集成,前端或者后端無(wú)法做到“及時(shí)協(xié)商,盡早解決”,最終導(dǎo)致問(wèn)題集中爆發(fā)

解決方案

首先定義計(jì)劃的提綱,并實(shí)時(shí)跟蹤最新的API,降低集成風(fēng)險(xiǎn)

Swagger

  • 號(hào)稱(chēng)世界上最流行的API框架
  • Restful Api 文檔在線自動(dòng)生成器 =>API 文檔 與API 定義同步更新
  • 直接運(yùn)行,可以在線測(cè)試API接口;
  • 支持多種語(yǔ)言 (如:Java,PHP等)
  • 官網(wǎng):https://swagger.io/

SpringBoot集成Swagger

新建一個(gè)springboot-web項(xiàng)目

下載maven依賴(lài)https://mvnrepository.com/search?q=springfox

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

高版本是沒(méi)有第5部的測(cè)試頁(yè)面

3.0.0版本的要先在啟動(dòng)類(lèi)中加上注解@EnableOpenApi先在導(dǎo)入<groupId>io.springfox</groupId><artifactId>springfox-boot-starter</artifactId>

編寫(xiě)Controller,測(cè)試運(yùn)行成功

配置Swagger=》在包Config下

package com.hxl.config;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2 //開(kāi)啟swagger2
public class SwaggerConfig {
}

測(cè)試運(yùn)行:http://localhost:8080/swagger-ui.html

配置Swagger

Swagger實(shí)例Bean是Docket,所以通過(guò)配置Docket實(shí)例來(lái)配置Swaggger。

//配置了Swagger的Docket實(shí)例
@Bean
public Docket docket(){
    return new Docket(DocumentationType.SWAGGER_2);
}

再通過(guò)ApiInfo()屬性配置文檔信息

private ApiInfo apiInfo(){
    //作者信息
    Contact contact = new Contact("王木木","https://blog.csdn.net/qq_43585922?spm=1000.2115.3001.5343","11@qq.com");
    return new ApiInfo(
        "Swagger筆記", //標(biāo)題
        "沖沖沖", //描述
        "v1.0。0", //版本
        "https://blog.csdn.net/qq_43585922?spm=1000.2115.3001.5343", //組織鏈接
        contact, //聯(lián)系人信息
        "Apach 2.0 許可", //許可
        "許可鏈接", //許可連接
        new ArrayList<>()//擴(kuò)展
    );
}

Docket關(guān)聯(lián)上ApiInfo

@Bean
public Docket docket(){
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}

啟動(dòng)項(xiàng)目,訪問(wèn)http://localhost:8080/swagger-ui.html

Swagger配置掃描接口

構(gòu)建Docket時(shí)通過(guò)select()方法配置怎么掃描接口。select()build()是一套的

//配置了Swagger的Docket實(shí)例
@Bean
public Docket docket(){
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        /*
                RequestHandlerSelectors:要掃描接口的方式
                basePackage:指定要掃描的包
                any():掃描全部
                none():不掃描
                withClassAnnotation:掃描類(lèi)上的注解,參數(shù)是一個(gè)注解的反射對(duì)象
                withMethodAnnotation:掃描方法上的注解
                path():過(guò)濾什么路徑
                */
        .apis(RequestHandlerSelectors.basePackage("com.hxl.controller"))
        //.paths(PathSelectors.ant("/hxl/**"))
        .build();
}

我們看之前的運(yùn)行結(jié)構(gòu)可以看到有base-error-controllerhello-controller,一旦使用了上述配置后,運(yùn)行結(jié)果只有hello-controller

配置是否啟動(dòng)Swagger

通過(guò)enable()方法配置是否啟用swagger

@Bean
public Docket docket(){
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        //enable是否啟動(dòng)Swagger,默認(rèn)為true,如果該位false則不能在瀏覽器中訪問(wèn)
        .enable(false)
        .select()
        /*
                RequestHandlerSelectors:要掃描接口的方式
                basePackage:指定要掃描的包
                any():掃描全部
                none():不掃描
                withClassAnnotation:掃描類(lèi)上的注解,參數(shù)是一個(gè)注解的反射對(duì)象
                withMethodAnnotation:掃描方法上的注解
                path():過(guò)濾什么路徑
                */
        .apis(RequestHandlerSelectors.basePackage("com.hxl.controller"))
        //.paths(PathSelectors.ant("/hxl/**"))
        .build();
}

Swagger在生產(chǎn)環(huán)境中使用,在發(fā)布的時(shí)候不使用

  • 判斷是否是生產(chǎn)環(huán)境
  • 注入enable()值

當(dāng)我們有多個(gè)生產(chǎn)環(huán)境時(shí)。比如說(shuō)application-dev.yamlapplication-pro.yaml。動(dòng)態(tài)設(shè)置當(dāng)前項(xiàng)目處于dev時(shí)顯示swagger,Pro是不顯示

#哪個(gè)環(huán)境生效
spring.profiles.active=dev

設(shè)置我們的dev走8081,默認(rèn)走8080,pro走8082

然后修改我們的配置

@Bean
public Docket docket(Environment environment){
    //設(shè)置顯示的Swagger環(huán)境
    Profiles profiles = Profiles.of("dev", "test");
    //通過(guò)  判斷是否處在自己設(shè)定的環(huán)境中
    boolean flag = environment.acceptsProfiles(profiles);
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        //這里變成了flag
        .enable(flag)
        .select()     
        .apis(RequestHandlerSelectors.basePackage("com.hxl.controller"))
        .build();
}

此時(shí)我們就發(fā)現(xiàn),如果我們走默認(rèn)的8080是沒(méi)有Swagger的,走8081才有

配置API文檔的分組

@Bean
public Docket docket(Environment environment){
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .groupName("王木木");
    //其余配置省略
}

啟動(dòng)項(xiàng)目就發(fā)現(xiàn)我們的組別有了

如果有多個(gè)分組怎么辦?只需要配置多個(gè)docket即可

//其他的環(huán)境需要自己填
@Bean
public Docket docket1(){
    return new Docket(DocumentationType.SWAGGER_2).groupName("天");
}
@Bean
public Docket docket2(){
    return new Docket(DocumentationType.SWAGGER_2).groupName("狼");
}

實(shí)體類(lèi)配置

創(chuàng)建一個(gè)實(shí)體類(lèi)

package com.hxl.pojo;
public class User {
    public String username;
    public String password;
}

只要這個(gè)實(shí)體在請(qǐng)求接口的返回值上,就可以映射到實(shí)體項(xiàng)中

//只要我們的接口中,返回值存在實(shí)體類(lèi),他就會(huì)掃描到Swagger中
@PostMapping("/user")
public User user(){
    return new User();
}

測(cè)試

此時(shí)發(fā)現(xiàn)我們的Model中有了User。如果有中文的注釋?zhuān)恍枰诩觾蓚€(gè)注解

package com.hxl.pojo;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
//@Api("注釋")
@ApiModel("用戶(hù)實(shí)體類(lèi)")
public class User {
    @ApiModelProperty("姓名")
    public String username;
    @ApiModelProperty("密碼")
    public String password;
}

測(cè)試

常用的注解

Swagger的所有注解定義在io.swagger.annotations包下

Swagger注解簡(jiǎn)單說(shuō)明
@Api(tags = “xxx模塊說(shuō)明”)作用在模塊類(lèi)上
@ApiOperation(“xxx接口說(shuō)明”)作用在接口方法上
@ApiModel(“xxxPOJO說(shuō)明”)作用在模型類(lèi)上:如VO、BO
@ApiModelProperty(value = “xxx屬性說(shuō)明”,hidden = true)作用在類(lèi)方法和屬性上,hidden設(shè)置為true可以隱藏該屬性
@ApiParam(“xxx參數(shù)說(shuō)明”)作用在參數(shù)、方法和字段上

注解在類(lèi)上的可以看一下上面的,接下來(lái)看注解在接口方法上,以及參數(shù)上

@ApiOperation("王木木的接口")
@PostMapping("/hxl")
public String hxl(@ApiParam("用戶(hù)名")String username){
    return username;
}

在這里還可以進(jìn)行測(cè)試

小結(jié)

  • 我們可以通過(guò)Swagger給一些比較難理解的屬性或者接口增加注釋信息
  • 接口文檔實(shí)時(shí)更新
  • 可以在線測(cè)試
  • 在正式發(fā)布的時(shí)候一定要關(guān)閉Swagger《安全;節(jié)省運(yùn)行的內(nèi)存》

到此這篇關(guān)于springBoot詳解集成Swagger流程的文章就介紹到這了,更多相關(guān)springBoot Swagger內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

相關(guān)文章

  • MyBatis-plus的五種批量插入方式對(duì)比分析

    MyBatis-plus的五種批量插入方式對(duì)比分析

    本文主要介紹了MyBatis-plus的五種批量插入方式對(duì)比分析,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧
    2023-06-06
  • Java設(shè)計(jì)模式常用原則解析

    Java設(shè)計(jì)模式常用原則解析

    這篇文章主要介紹了Java設(shè)計(jì)模式常用原則解析,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
    2020-05-05
  • java實(shí)現(xiàn)文件上傳下載功能

    java實(shí)現(xiàn)文件上傳下載功能

    這篇文章主要介紹了java實(shí)現(xiàn)文件上傳下載功能,上傳單個(gè)或多個(gè)文件,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下
    2021-08-08
  • Java實(shí)現(xiàn)數(shù)字金額轉(zhuǎn)化為英文金額功能

    Java實(shí)現(xiàn)數(shù)字金額轉(zhuǎn)化為英文金額功能

    在處理財(cái)務(wù)數(shù)據(jù)時(shí),有時(shí)需要將數(shù)字形式的金額轉(zhuǎn)換成英文描述的形式,比如在生成正式文件或發(fā)票時(shí),本文將介紹如何使用Java實(shí)現(xiàn)這一功能,需要的朋友可以參考下
    2025-03-03
  • 頁(yè)面設(shè)計(jì)之事件處理綜合介紹

    頁(yè)面設(shè)計(jì)之事件處理綜合介紹

    頁(yè)面設(shè)計(jì)之事件處理,當(dāng)你把界面都設(shè)計(jì)好了,總需要添加相應(yīng)的執(zhí)行動(dòng)作給組件,在有相應(yīng)的時(shí)間處理機(jī)制
    2012-12-12
  • Spring實(shí)戰(zhàn)之使用TransactionProxyFactoryBean實(shí)現(xiàn)聲明式事務(wù)操作示例

    Spring實(shí)戰(zhàn)之使用TransactionProxyFactoryBean實(shí)現(xiàn)聲明式事務(wù)操作示例

    這篇文章主要介紹了Spring實(shí)戰(zhàn)之使用TransactionProxyFactoryBean實(shí)現(xiàn)聲明式事務(wù)操作,結(jié)合實(shí)例形式分析了spring使用TransactionProxyFactoryBean實(shí)現(xiàn)聲明式事務(wù)相關(guān)配置、接口設(shè)置與使用技巧,需要的朋友可以參考下
    2020-01-01
  • IDEA2020.1常用配置說(shuō)明

    IDEA2020.1常用配置說(shuō)明

    這篇文章主要介紹了IDEA2020.1常用配置說(shuō)明,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧
    2020-06-06
  • java實(shí)現(xiàn)超市庫(kù)存管理系統(tǒng)

    java實(shí)現(xiàn)超市庫(kù)存管理系統(tǒng)

    這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)超市庫(kù)存管理系統(tǒng),文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下
    2019-10-10
  • java定時(shí)調(diào)度器(Quartz)使用實(shí)例

    java定時(shí)調(diào)度器(Quartz)使用實(shí)例

    這篇文章主要介紹了java開(kāi)源定時(shí)調(diào)度器使用方法
    2013-12-12
  • 淺談JAVA中輸入輸出流實(shí)例詳解

    淺談JAVA中輸入輸出流實(shí)例詳解

    Java中的流分為兩種,一種是字節(jié)流,另一種是字符流。這篇文章主要介紹了JAVA中輸入輸出流的相關(guān)資料,需要的朋友可以參考下
    2016-07-07

最新評(píng)論

陆良县| 泸州市| 湘阴县| 水富县| 吴江市| 江津市| 隆安县| 绥德县| 正镶白旗| 班玛县| 化隆| 望都县| 洛扎县| 那曲县| 潍坊市| 航空| 沈阳市| 西和县| 恩施市| 老河口市| 烟台市| 乳源| 永靖县| 湖州市| 土默特左旗| 西充县| 阜宁县| 曲周县| 方城县| 阿图什市| 米林县| 罗江县| 股票| 涞源县| 诸暨市| 浦县| 德清县| 新兴县| 集安市| 德州市| 大名县|