1. 程式人生 > 實用技巧 >小白的springboot之路(十九)、整合swagger(com.spring4all篇)

小白的springboot之路(十九)、整合swagger(com.spring4all篇)

0-前言

整合swagger,有兩種方式:

  一種在前面已經介紹過了,直接整合官方的springfox-swagger2的方式,這種方式需要在配置類中配置

  第二種方式是這裡要介紹的方式,國人寫的com.spring4all的方式,這種方式其實是對第一種方式的進一步封裝,

  只是把配置從配置類中配置提取到了在配置檔案配置,看個人喜好了,你喜歡在配置檔案中配置swagger基本屬性的可以用com.spring4all

1-實現

  簡單4步輕鬆實現:

1-1、新增依賴:

        <!-- swagger -->
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.9.1.RELEASE</version>
        </dependency>

1-2、啟動類中添加註解

@EnableSwagger2Doc

1-3、配置檔案中新增配置

區別其實也主要在這裡,以前我們是寫死在配置類種的,現在可以在配置檔案中配置,好處是可以不需要變動程式,隨時更改;

#swagger配置
swagger:
  enable: true
  title: OSS服務
  description: OSS基礎服務API
  version: ${project.version}
  base-package: com.example.oss
  base-path: /**
  exclude-path: /error
  authorization:
    key-name: Authorization

1-4、使用

跟以前的方式是一樣的

   @GetMapping("/getmsg")
    @ApiOperation(value = "I18N", notes = "獲取I18N值")
    public String language() 
{
        String message =LocalUtil.get("user.appname");
        return message;
    }

完畢,蘿蔔青菜,各有所愛,你喜歡在配置類中來寫,還是在配置檔案來配置,看個人喜歡來自己選擇;

實際專案上線的時候,swagger一般都是要關閉的,所以其實哪種都一樣的;

就我而言,更喜歡在配置類中來寫,這樣不會汙染配置檔案;

配置檔案是貫穿我們專案整個生命週期的,與上線無關的配置我們都不希望在配置檔案中出現;

當然,看個人喜歡;