knife4j

最新推荐文章于 2024-07-09 20:05:11 发布

狂崔三浪

最新推荐文章于 2024-07-09 20:05:11 发布

阅读量124

点赞数

文章标签： java 开发语言

本文链接：https://blog.csdn.net/qq_52967534/article/details/131407508

版权

文章介绍了如何在项目中引入Knife4j，一个用于生成和展示RESTfulAPI文档的工具，替代Swagger。通过添加依赖，配置@EnableSwagger2WebMvc注解，创建DocketBean以及设定APIInfo，开发者可以便捷地为SpringBoot应用创建详细的接口文档。

摘要由CSDN通过智能技术生成

我在一次项目中无意中接触到了knife4j这个特殊的依赖，我就去查了一下，发现是一种类似于swagger的接口文档工具，我就想去尝试一下。

导入依赖：

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

注意：

本依赖已经包含了swagger依赖，可以不用导入。

配置文件：

 knife4j:
   enable: true

开启增强依赖

swagger配置类

 @Configuration
 @EnableSwagger2WebMvc
 public class SwaggerConfig {
     // 创建Docket存入容器，Docket代表一个接口文档
     @Bean
     public Docket webApiConfig(){
         return new Docket(DocumentationType.SWAGGER_2)
                 // 创建接口文档的具体信息
                 .apiInfo(webApiInfo())
                 // 创建选择器，控制哪些接口被加入文档
                 .select()
                 // 指定@ApiOperation标注的接口被加入文档
                 .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                 .build();
     }
 
     // 创建接口文档的具体信息，会显示在接口文档页面中
     private ApiInfo webApiInfo(){
         return new ApiInfoBuilder()
                 // 文档标题
                 .title("标题：用户管理系统接口文档")
                 // 文档描述
                 .description("描述：本文档描述了用户管理系统的接口定义")
                 // 版本
                 .version("1.0")
                 // 联系人信息
                 .contact(new Contact("chengjian", "http://baidu.com", "baidu@qq.com"))
                 // 版权
                 .license("baobao")
                 // 版权地址
                 .licenseUrl("http://www.baidu.com")
                 .build();
     }
 }