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

Spring Boot配置Swagger的實(shí)現(xiàn)代碼

 更新時(shí)間:2018年12月23日 16:23:09   作者:hrabbits  
這篇文章主要介紹了Spring Boot配置Swagger的實(shí)現(xiàn)代碼,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來(lái)看看吧

由于Spring Boot能夠快速開發(fā)、便捷部署等特性,相信有很大一部分Spring Boot的用戶會(huì)用來(lái)構(gòu)建RESTful API。而我們構(gòu)建RESTful API的目的通常都是由于多終端的原因,這些終端會(huì)共用很多底層業(yè)務(wù)邏輯,因此我們會(huì)抽象出這樣一層來(lái)同時(shí)服務(wù)于多個(gè)移動(dòng)端或者Web前端。

Swagger Inspector:測(cè)試API和生成OpenAPI的開發(fā)工具。Swagger Inspector的建立是為了解決開發(fā)者的三個(gè)主要目標(biāo)。

  • 執(zhí)行簡(jiǎn)單的API測(cè)試
  • 生成OpenAPI文檔
  • 探索新的API功能

下面來(lái)具體介紹,如果在Spring Boot中使用Swagger2。

添加Swagger2依賴

在pom.xml中加入Swagger2的依賴

 <!-- Swagger API-->
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.2.2</version>
    </dependency>
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.2.2</version>
    </dependency>

創(chuàng)建Swagger2配置類

在HrabbitAdminApplication.java子包下創(chuàng)建Swagger2的配置類Swagger2。

通過@Configuration注解,讓Spring來(lái)加載該類配置。再通過@EnableSwagger2注解來(lái)啟用Swagger2。

再通過createRestApi函數(shù)創(chuàng)建Docket的Bean之后,apiInfo()用來(lái)創(chuàng)建該Api的基本信息(這些基本信息會(huì)展現(xiàn)在文檔頁(yè)面中)。select()函數(shù)返回一個(gè)ApiSelectorBuilder實(shí)例用來(lái)控制哪些接口暴露給Swagger來(lái)展現(xiàn),包含注解的方式來(lái)確定要顯示的接口,當(dāng)然也可以通過包掃描的方式來(lái)確定要顯示的包的接口。

/**
 * 配置Swagger
 *
 * @Auther: hrabbit
 * @Date: 2018-12-17 6:43 PM
 * @Description:
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))             //這里采用包含注解的方式來(lái)確定要顯示的接口
        //.apis(RequestHandlerSelectors.basePackage("com.hrabbit.admin.modual.system.controller"))  //這里采用包掃描的方式來(lái)確定要顯示的接口
        .paths(PathSelectors.any())
        .build();
  }

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("Hrabbit-Admin Doc")
        .description("Guns Api文檔")
        .termsOfServiceUrl("https://gitee.com/hrabbit/hrabbit-admin")
        .contact("hrabbit")
        .version("1.0")
        .build();
  }

}

添加文檔內(nèi)容

我們通過@Api說(shuō)明Controller,@ApiOperation注解來(lái)給API增加說(shuō)明、通過@ApiImplicitParams、@ApiImplicitParam注解來(lái)給參數(shù)增加說(shuō)明。

/**
 * 系統(tǒng)用戶
 *
 * @Auther: hrabbit
 * @Date: 2018-12-17 6:21 PM
 * @Description:
 */
@Controller
@RequestMapping("user")
@Api(value = "系統(tǒng)用戶")
public class SysUserController {

  @Autowired
  private SysUserService sysUserService;

  /**
   * 根據(jù)id獲取用戶信息
   *
   * @return
   */
  @RequestMapping("/",method = RequestMethod.GET)
  @ResponseBody
  @ApiOperation(value = "進(jìn)入到主頁(yè)")
  public Object index() {
    return sysUserService.selectById(1L);
  }

  /**
   * 創(chuàng)建用戶信息
   *
   * @param user
   * @return
   */
  @ApiOperation(value = "創(chuàng)建用戶", notes = "根據(jù)SysUser對(duì)象創(chuàng)建用戶")
  @ApiImplicitParam(name = "user", value = "用戶詳細(xì)實(shí)體user", required = true, dataType = "SysUser")
  @RequestMapping(value = "", method = RequestMethod.POST)
  public String postUser(@RequestBody SysUser user) {
    return "success";
  }

  /**
   * 修改用戶信息
   *
   * @param id
   * @param user
   * @return
   */
  @ApiOperation(value = "更新用戶詳細(xì)信息", notes = "根據(jù)id更新系統(tǒng)用戶")
  @ApiImplicitParams({
      @ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long"),
      @ApiImplicitParam(name = "user", value = "用戶詳細(xì)實(shí)體sysUser", required = true, dataType = "SysUser")
  })
  @RequestMapping(value = "/{id}", method = RequestMethod.PUT)
  public String putUser(@PathVariable Long id, @RequestBody SysUser user) {
    return "success";
  }

}

完成上述代碼添加上,啟動(dòng)Spring Boot程序,訪問:http://localhost:8080/swagger-ui.html
。就能看到前文所展示的RESTful API的頁(yè)面。我們可以再點(diǎn)開具體的API請(qǐng)求,以POST類型的/user請(qǐng)求為例,可找到上述代碼中我們配置的Notes信息以及參數(shù)user的描述信息,如下圖所示。

API文檔訪問與調(diào)試

在上圖請(qǐng)求的頁(yè)面中,我們看到user的Value是個(gè)輸入框?是的,Swagger除了查看接口功能外,還提供了調(diào)試測(cè)試功能,我們可以點(diǎn)擊上圖中右側(cè)的Model Schema(黃色區(qū)域:它指明了User的數(shù)據(jù)結(jié)構(gòu)),此時(shí)Value中就有了user對(duì)象的模板,我們只需要稍適修改,點(diǎn)擊下方“Try it out!”按鈕,即可完成了一次請(qǐng)求調(diào)用!

本篇文章,一些文字內(nèi)容借鑒了程序猿DD的Swagger內(nèi)容,該系列文章內(nèi)容主要以如何搭建一個(gè)完整的后臺(tái)Spirng Boot Cli為主,其他的基礎(chǔ)信息可以參考其他博主內(nèi)容!

碼云地址:https://gitee.com/hrabbit/hrabbit-admin

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

相關(guān)文章

  • Java中Scanner類與BufferReader類的不同點(diǎn)(非常詳細(xì))

    Java中Scanner類與BufferReader類的不同點(diǎn)(非常詳細(xì))

    這篇文章主要介紹了Java中Scanner類與BufferReader類的不同點(diǎn)(非常詳細(xì))的相關(guān)資料,需要的朋友可以參考下
    2016-08-08
  • 淺談Java響應(yīng)式系統(tǒng)

    淺談Java響應(yīng)式系統(tǒng)

    第一次聽到reactive這個(gè)詞還是在幾年前,偶然了解到了Rxjava這個(gè)項(xiàng)目,仿佛為我打開了一扇新的大門,Rxjava是ReactiveX的java實(shí)現(xiàn),ReactiveX家族除了Rxjava還有RxJS, Rx.NET,RxScala等等。
    2021-06-06
  • Java流處理stream使用詳解

    Java流處理stream使用詳解

    Java8的另一大亮點(diǎn)Stream,它與java.io包里的InputStream和OutputStream是完全不同的概念,下面這篇文章主要給大家介紹了關(guān)于Java8中Stream詳細(xì)使用方法的相關(guān)資料,需要的朋友可以參考下
    2022-10-10
  • ThreadLocal常用方法、使用場(chǎng)景及注意事項(xiàng)說(shuō)明

    ThreadLocal常用方法、使用場(chǎng)景及注意事項(xiàng)說(shuō)明

    這篇文章主要介紹了ThreadLocal常用方法、使用場(chǎng)景及注意事項(xiàng)說(shuō)明,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
    2021-10-10
  • 基于sharding-jdbc的使用限制

    基于sharding-jdbc的使用限制

    這篇文章主要介紹了sharding-jdbc的使用限制,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
    2021-10-10
  • java PDF添加圖層的方法 支持多頁(yè)圖層添加

    java PDF添加圖層的方法 支持多頁(yè)圖層添加

    這篇文章主要為大家詳細(xì)介紹了java PDF添加圖層的方法,支持多頁(yè)圖層添加,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下
    2018-02-02
  • Ribbon負(fù)載均衡算法原理與使用介紹

    Ribbon負(fù)載均衡算法原理與使用介紹

    在微服務(wù)中,對(duì)服務(wù)進(jìn)行拆分之后,必然會(huì)帶來(lái)微服務(wù)之間的通信需求,而每個(gè)微服務(wù)為了保證高可用性,又會(huì)去部署集群,那么面對(duì)一個(gè)集群微服務(wù)進(jìn)行通信的時(shí)候,如何進(jìn)行負(fù)載均衡也是必然需要考慮的問題
    2022-09-09
  • 詳解Mybatis多參數(shù)傳遞入?yún)⑺姆N處理方式

    詳解Mybatis多參數(shù)傳遞入?yún)⑺姆N處理方式

    這篇文章主要介紹了詳解Mybatis多參數(shù)傳遞入?yún)⑺姆N處理方式,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧
    2021-04-04
  • Java中的值傳遞和引用傳遞實(shí)例介紹

    Java中的值傳遞和引用傳遞實(shí)例介紹

    java 中沒有引用傳遞,都是值傳遞的,可以通過傳遞副本修改對(duì)象的,副本交換,并不影響原引用
    2013-09-09
  • Java實(shí)現(xiàn)顯示指定類型的文件

    Java實(shí)現(xiàn)顯示指定類型的文件

    這篇文章主要介紹了Java實(shí)現(xiàn)顯示指定類型的文件,需要的朋友可以參考下
    2014-03-03

最新評(píng)論