Spring Boot整合Knife4j

小林是程序员

已于 2024-04-27 14:54:41 修改

阅读量387

点赞数 11

分类专栏： Api文档工具文章标签： spring boot 后端 java

于 2024-04-26 17:32:37 首次发布

本文链接：https://blog.csdn.net/weixin_45972546/article/details/138224229

版权

Api文档工具专栏收录该内容

1 篇文章 0 订阅

订阅专栏

Knife4j是什么

Knife4j是一个集Swagger2和OpenAPI3为一体的Api文档增强工具

Spring Boot整合Knife4j

引入maven依赖

 <dependencies>
  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
      <version>2.3.6.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>knife4j-spring-boot-starter</artifactId>
      <version>2.0.9</version>
    </dependency>
  </dependencies>

创建Knife4j配置类

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfig {
    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        //.title("swagger-bootstrap-ui-demo RESTful APIs")
                        .description("# swagger-bootstrap-ui-demo RESTful APIs")
                        .termsOfServiceUrl("http://www.xx.com/")
                        .contact("xx@qq.com")
                        .version("1.0")
                        .build())
                //分组名称
                .groupName("2.X版本")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.xiaolin.knife4j.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}

创建一个Controller

@RestController
@RequestMapping("/knife4j")
@Api(tags = "演示模块")  // Knife4j注解，对Controller进行说明
public class HelloController {

    @ApiOperation(value = "向客人问好")  // Knife4j注解，对接口进行说明
    @GetMapping("/sayHello")
    public String sayHello(@RequestParam(value = "name") String name) {
        return "sayHello:" + name;
    }
}