接口文檔總是很煩人，我曾經(jīng)嘗試過用Postman來編寫和分享項目文檔，感覺還不錯。但是最近項目緊，我沒有額外的時間可以花在它上面，這也導致我嘗試YApi(另外一種文檔)的計劃泡湯了。嗯，目前沒有比Swagger更快、更傻瓜的工具，雖然它有嚴重的代碼污染。先拿這個對付一陣時間，等閑暇時間再玩YApi。

創(chuàng)新互聯(lián)公司專業(yè)為企業(yè)提供石家莊網(wǎng)站建設、石家莊做網(wǎng)站、石家莊網(wǎng)站設計、石家莊網(wǎng)站制作等企業(yè)網(wǎng)站建設、網(wǎng)頁設計與制作、石家莊企業(yè)網(wǎng)站模板建站服務，十載石家莊做網(wǎng)站經(jīng)驗，不只是建網(wǎng)站，更提供有價值的思路和整體網(wǎng)絡服務。

Swagger3集成

Swagger目前最新版本是3.0.0,在Spring Boot應用中集成Swagger3比老的Swagger2簡單多了，它提供了一個Starter組件。

 
 
 
 

  
  
  
  

  
  
  
  
    io.springfox
  
  
  
  
    springfox-boot-starter
  
  
  
  
    3.0.0
  
  
  
  

 
 
 
 

就這就可以了，簡單不?

至于有的教程說還要開啟注解@EnableOpenApi，完全不需要。因為在springfox-boot-starter-3.0.0.jar下你可以找到一個spring.factories，熟悉Spring Boot的同學都知道這個是一個Spring Boot 特有的SPI文件，能夠自動的發(fā)現(xiàn)并注冊Starter組件的配置。里面有這樣的配置：

 
 
 
 

  
  
  
  
# Auto Configure
  
  
  
  
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  
  
  
  
springfox.boot.starter.autoconfigure.OpenApiAutoConfiguration
 
 
 
 

順藤摸瓜，找到總的配置類OpenApiAutoConfiguration：

 
 
 
 

  
  
  
  
@Configuration
  
  
  
  
@EnableConfigurationProperties(SpringfoxConfigurationProperties.class)
  
  
  
  
@ConditionalOnProperty(value = "springfox.documentation.enabled", havingValue = "true", matchIfMissing = true)
  
  
  
  
@Import({
  
  
  
  
    OpenApiDocumentationConfiguration.class,
  
  
  
  
    SpringDataRestConfiguration.class,
  
  
  
  
    BeanValidatorPluginsConfiguration.class,
  
  
  
  
    Swagger2DocumentationConfiguration.class,
  
  
  
  
    SwaggerUiWebFluxConfiguration.class,
  
  
  
  
    SwaggerUiWebMvcConfiguration.class
  
  
  
  
})
  
  
  
  
@AutoConfigureAfter({ WebMvcAutoConfiguration.class, JacksonAutoConfiguration.class,
  
  
  
  
    HttpMessageConvertersAutoConfiguration.class, RepositoryRestMvcAutoConfiguration.class })
  
  
  
  
public class OpenApiAutoConfiguration {
  
  
  
  

  
  
  
  
}
 
 
 
 

一些發(fā)現(xiàn)

我們找到了關(guān)鍵的一個地方@ConditionalOnProperty注解聲明了當springfox.documentation.enabled為true時啟用配置，而且默認值就是true。這非常有用，Swagger僅僅建議在開發(fā)階段使用，這個正好是個開關(guān)。另外有時候我們自定義配置的時候最好把這個開關(guān)也加上：

 
 
 
 

  
  
  
  
// 自定義swagger3文檔信息
  
  
  
  
@Configuration
  
  
  
  
@ConditionalOnProperty(value = "springfox.documentation.enabled", havingValue = "true", matchIfMissing = true)
  
  
  
  
public class Swagger3Config {
  
  
  
  
    @Bean
  
  
  
  
    public Docket createRestApi() {
  
  
  
  
        return new Docket(DocumentationType.OAS_30)
  
  
  
  
                .apiInfo(apiInfo())
  
  
  
  
                .select()
  
  
  
  
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
  
  
  
  
                .paths(PathSelectors.any())
  
  
  
  
                .build();
  
  
  
  
    }
  
  
  
  

  
  
  
  
    private ApiInfo apiInfo() {
  
  
  
  
        return new ApiInfoBuilder()
  
  
  
  
                .title("Swagger3接口文檔")
  
  
  
  
                .description("更多請咨詢felord.cn")
  
  
  
  
                .contact(new Contact("碼農(nóng)小胖哥", "https://felord.cn", "[email protected]"))
  
  
  
  
                .version("1.0.0")
  
  
  
  
                .build();
  
  
  
  
    }
  
  
  
  
}
 
 
 
 

如果你想在Swagger3中加入Json Web Token，可以參考這篇文章。

最開始我們提到Swagger3不需要使用@EnableOpenApi或者@EnableSwagger2開啟，這里也能找到答案。

 
 
 
 

  
  
  
  
@Import(OpenApiDocumentationConfiguration.class)
  
  
  
  
public @interface EnableOpenApi {
  
  
  
  
}
  
  
  
  
@Import(Swagger2DocumentationConfiguration.class)
  
  
  
  
public @interface EnableSwagger2 {
  
  
  
  
}
 
 
 
 

上面的兩個導入類都可以在OpenApiAutoConfiguration找到，所以Swagger3提供的是全自動的集成。

和全局統(tǒng)一參數(shù)不兼容

如果你使用了統(tǒng)一返回體封裝器來標準化Spring MVC接口的統(tǒng)一返回

 
 
 
 

  
  
  
  
/**
  
  
  
  
 * 返回體統(tǒng)一封裝器
  
  
  
  
 *
  
  
  
  
 * @author n1
  
  
  
  
 */
  
  
  
  
@RestControllerAdvice 
  
  
  
  
public class RestBodyAdvice implements ResponseBodyAdvice