SpringBoot2.x集成knife4j

什么是knife4j，為什么要使用knife4j?
簡單說knife4j就swagger的升級版API文檔的一個框架,但是用起來比swagger方便多了，UI更加豐富。

如何使用knife4j?
簡略的說一下，基礎環境搭建可參考：SpringBoot2.x集成Swagger2

這里我說一下主要配置區別：

環境說明：

新增 knife4j.version：2.0.2

1.導入pom依賴

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>3.0.3</version>
</dependency>

2.knife4j配置類基本與swagger配置類一致

@Configuration
@EnableSwagger2
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfig {
    @Bean(value = "createRestApi")
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        //標題
                        .title("項目API接口")
                        //版本信息
                        .version("1.0")
                        //描述消息
                        .description("接口列表")
                        .contact(new Contact("項目API接口","localhost:8801/demo/doc.html","[e-mail]"))
                        .license("mamba")
//                        .licenseUrl("http://www.xxxx.com/")
                        .build())
                //最終調用接口后會和paths拼接在一起
                .pathMapping("/")
                .select()
                //包路徑
                .apis(RequestHandlerSelectors.basePackage("com.rd.ml.cli.swagger.controller"))
                //過濾的接口
                .paths(PathSelectors.any())
                .build();
    }
}

.yml配置

# swagger開啟
swagger:
  enable: true
# 是否停用Knife4j文檔
knife4j:
  production: false

3. knife4j用法與swagger基本一致，訪問根目錄/doc.html

http://xxxxxx/doc.html

 

版權聲明：本文為CSDN博主「＂涼涼_____」的原創文章，遵循CC 4.0 BY-SA版權協議，轉載請附上原文出處鏈接及本聲明。
原文鏈接：https://blog.csdn.net/weixin_44739349/article/details/105839318