小白的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一般都是要關閉的，所以其實哪種都一樣的；

就我而言，更喜歡在配置類中來寫，這樣不會污染配置文件；

配置文件是貫穿我們項目整個生命周期的，與上線無關的配置我們都不希望在配置文件中出現；

當然，看個人喜歡；