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

springboot2.x集成swagger的方法示例

 更新時(shí)間:2019年05月24日 10:16:08   作者:荔枝  
這篇文章主要介紹了springboot2.x集成swagger的方法示例,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

集成swagger

pom包配置

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.9.2</version>
</dependency>
<!-- swagger-ui -->
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>${swagger.version}</version>
</dependency>

添加Swagger配置文件

@Configuration
@EnableSwagger2
public class SwaggerConfig {
  /**
   * 創(chuàng)建一個(gè)Docket對(duì)象
   * 調(diào)用select()方法,
   * 生成ApiSelectorBuilder對(duì)象實(shí)例,該對(duì)象負(fù)責(zé)定義外漏的API入口
   * 通過(guò)使用RequestHandlerSelectors和PathSelectors來(lái)提供Predicate,在此我們使用any()方法,將所有API都通過(guò)Swagger進(jìn)行文檔管理
   * @return
   */
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.any())
        .paths(PathSelectors.any())
        .build();
  }

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        //標(biāo)題
        .title("Spring Boot中使用Swagger2構(gòu)建RESTful APIs")
        //簡(jiǎn)介
        .description("")
        //服務(wù)條款
        .termsOfServiceUrl("")
        //作者個(gè)人信息
        .contact(new Contact("chenguoyu","","chenguoyu_sir@163.com"))
        //版本
        .version("1.0")
        .build();
  }
}

如果不想將所有的接口都通過(guò)swagger管理的話,可以將RequestHandlerSelectors.any()修改為RequestHandlerSelectors.basePackage()

配置靜態(tài)訪問(wèn)資源

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
  @Override
  public void addResourceHandlers(ResourceHandlerRegistry registry) {
    // 解決 swagger-ui.html 404報(bào)錯(cuò)
    registry.addResourceHandler("/swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
  }
}

到這里為止swagger就已經(jīng)配置完了,可以啟動(dòng)項(xiàng)目,然后訪問(wèn)如下鏈接即可http://localhost:9000/swagger...

端口號(hào)applicationContext中設(shè)置的端口號(hào)。

集成swagger-bootstrap-ui

由于個(gè)人感覺(jué)原生的swagger-ui不太好看,網(wǎng)上提供了swagger-bootstrap-ui。

pom依賴(lài)

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

配置靜態(tài)訪問(wèn)資源

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
  @Override
  public void addResourceHandlers(ResourceHandlerRegistry registry) {
    // 解決 swagger-ui.html 404報(bào)錯(cuò)
    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/");

  }
}

這時(shí)只需要訪問(wèn)以下鏈接即可http://localhost:9000/doc.html

swagger常用注解

@Api:用在類(lèi)上,標(biāo)志此類(lèi)是Swagger資源

屬性名稱(chēng) 備注
value 該參數(shù)沒(méi)什么意義,在UI界面上不顯示,所以不用配置
tags 說(shuō)明該類(lèi)的作用,參數(shù)是個(gè)數(shù)組,可以填多個(gè)
description 對(duì)api資源的描述

@ApiOperation:用在方法上,描述方法的作用

屬性名稱(chēng) 備注
value 方法的用途和作用
tags 方法的標(biāo)簽,可以設(shè)置多個(gè)值
notes 方法的注意事項(xiàng)和備注
response 返回的類(lèi)型(盡量不寫(xiě),由swagger掃描生成)

@ApiImplicitParams:包裝器:包含多個(gè)ApiImplicitParam對(duì)象列表

屬性名稱(chēng) 備注
value 多個(gè)ApiImplicitParam配置

@ApiParam:用于Controller中方法的參數(shù)說(shuō)明

屬性名稱(chēng) 備注
name 屬性名稱(chēng)
value 屬性值
defaultValue 默認(rèn)屬性值
allowableValues 可以不配置
required 是否屬性必填
allowMultiple 文件上傳時(shí),是否允許多文件上傳

@ApiImplicitParam:定義在@ApiImplicitParams注解中,定義單個(gè)參數(shù)詳細(xì)信息,如果只有一個(gè)參數(shù),也可以定義在方法上

屬性名稱(chēng) 備注
name 參數(shù)名
value 參數(shù)說(shuō)明
dataType 參數(shù)類(lèi)型
paramType 表示參數(shù)放在哪里
header : 請(qǐng)求參數(shù)的獲?。篅RequestHeader
query : 請(qǐng)求參數(shù)的獲取:@RequestParam
path : 請(qǐng)求參數(shù)的獲?。篅PathVariable
body : 不常用
form : 不常用
defaultValue 參數(shù)的默認(rèn)值
required 參數(shù)是否必須傳

@ApiModel:用在類(lèi)上,表示對(duì)類(lèi)進(jìn)行說(shuō)明,用于實(shí)體類(lèi)中的參數(shù)接收說(shuō)明

屬性名稱(chēng) 備注
value 默認(rèn)為類(lèi)的名稱(chēng)
description 對(duì)該類(lèi)的描述

@ApiModelProperty:在model類(lèi)的屬性添加屬性說(shuō)明

屬性名稱(chēng) 備注
value 屬性描述
name 屬性名稱(chēng)
allowableValues 參數(shù)允許的值
dataType 數(shù)據(jù)類(lèi)型
required 是否必填

@ApiResponses:包裝器:包含多個(gè)ApiResponse對(duì)象列表

屬性名稱(chēng) 備注
value 多個(gè)ApiResponse配置

@ApiResponse:定義在@ApiResponses注解中,一般用于描述一個(gè)錯(cuò)誤的響應(yīng)信息

屬性名稱(chēng) 備注
code 響應(yīng)碼
message 狀態(tài)碼對(duì)應(yīng)的響應(yīng)信息
response 默認(rèn)響應(yīng)類(lèi) Void
responseContainer 參考ApiOperation中配置

@ApiIgnore():用于類(lèi)或者方法上,不被顯示在頁(yè)面上

總結(jié)

除上面之外有點(diǎn)值得注意的是,如果是上傳文件的話,需要把@ApiImplicitParam中的dataType屬性配置為_(kāi)_File否則在swagger中會(huì)顯示為文本框而不是上傳按鈕

如果需要項(xiàng)目代碼,可以去我的github中下載;具體代碼可以查看swagger目錄

以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。

相關(guān)文章

  • Java 8 Stream Api 中的 map和 flatMap 操作方法

    Java 8 Stream Api 中的 map和 flatMap 操作方法

    Java 8提供了非常好用的 Stream API ,可以很方便的操作集合。今天通過(guò)這篇文章給大家分享Java 8 Stream Api 中的 map和 flatMap 操作方法,需要的朋友可以參考下
    2019-11-11
  • 淺析Java Scanner 類(lèi)的用法

    淺析Java Scanner 類(lèi)的用法

    這篇文章主要介紹了Java Scanner 類(lèi)的用法,文中講解非常詳細(xì),代碼幫助大家更好的理解和學(xué)習(xí),感興趣的朋友可以了解下
    2020-07-07
  • java.lang.Instrument 代理Agent使用詳細(xì)介紹

    java.lang.Instrument 代理Agent使用詳細(xì)介紹

    這篇文章主要介紹了java.lang.Instrument 代理Agent使用詳細(xì)介紹的相關(guān)資料,附有實(shí)例代碼,幫助大家學(xué)習(xí)參考,需要的朋友可以參考下
    2016-11-11
  • Java判斷主機(jī)是否能ping通代碼實(shí)例

    Java判斷主機(jī)是否能ping通代碼實(shí)例

    這篇文章主要介紹了Java判斷主機(jī)是否能ping通代碼實(shí)例,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
    2020-01-01
  • FeignMultipartSupportConfig上傳圖片配置方式

    FeignMultipartSupportConfig上傳圖片配置方式

    這篇文章主要介紹了FeignMultipartSupportConfig上傳圖片配置方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
    2022-03-03
  • 使用Java實(shí)現(xiàn)價(jià)格加密與優(yōu)化功能

    使用Java實(shí)現(xiàn)價(jià)格加密與優(yōu)化功能

    在現(xiàn)代軟件開(kāi)發(fā)中,數(shù)據(jù)加密是一個(gè)非常重要的環(huán)節(jié),尤其是在處理敏感信息(如價(jià)格、用戶數(shù)據(jù)等)時(shí),本文將詳細(xì)介紹如何使用?Java?實(shí)現(xiàn)價(jià)格加密,并對(duì)代碼進(jìn)行優(yōu)化,需要的朋友可以參考下
    2025-01-01
  • Windows中使用Java生成Excel文件并插入圖片的方法

    Windows中使用Java生成Excel文件并插入圖片的方法

    這篇文章主要介紹了Windows中使用Java生成Excel文件并插入圖片的方法,其中向Excel中插入圖片文中通過(guò)使用Apache POI來(lái)實(shí)現(xiàn),需要的朋友可以參考下
    2016-02-02
  • 淺談Spring Boot 整合ActiveMQ的過(guò)程

    淺談Spring Boot 整合ActiveMQ的過(guò)程

    本篇文章主要介紹了淺談Spring Boot 整合ActiveMQ的過(guò)程,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧
    2017-12-12
  • Mybatis批量刪除多表

    Mybatis批量刪除多表

    MyBatis的作用我想不用多說(shuō),今天說(shuō)說(shuō)MyBatis中的批量刪除操作。 需要的朋友一起看看吧
    2017-10-10
  • Java中@DateTimeFormat和@JsonFormat注解介紹

    Java中@DateTimeFormat和@JsonFormat注解介紹

    @DateTimeFormat和@JsonFormat都是處理時(shí)間格式化問(wèn)題的,把其他類(lèi)型轉(zhuǎn)換成自己需要的時(shí)間類(lèi)型,下面這篇文章主要給大家介紹了關(guān)于Java中@DateTimeFormat和@JsonFormat注解介紹的相關(guān)資料,需要的朋友可以參考下
    2022-11-11

最新評(píng)論

留坝县| 休宁县| 铁岭县| 文山县| 美姑县| 阿坝县| 通城县| 疏勒县| 九寨沟县| 广南县| 惠来县| 巧家县| 阿坝县| 孝感市| 正镶白旗| 东丽区| 自贡市| 杭锦后旗| 灵武市| 烟台市| 白沙| 东明县| 抚宁县| 湘乡市| 章丘市| 永德县| 平泉县| 东兴市| 舒城县| 炉霍县| 天峻县| 渑池县| 舟曲县| 河源市| 安达市| 金寨县| 孟州市| 泾川县| 融水| 安新县| 清河县|