Knife4j 框架使用经历简化版

weixin_52572040

已于 2022-08-01 20:16:27 修改

阅读量1.1k

点赞数 23

文章标签： java 开发语言

于 2022-08-01 20:15:44 首次发布

本文链接：https://blog.csdn.net/weixin_52572040/article/details/126107878

版权

Knife4j 框架使用经历简化版

简介

Knife4j是java MVC框架集成Swagger生成Api文档的工具，前身是swagger-bootstrap-ui

另外，此框架还有调试功能，可以向服务器端发送请求，并获取响应结果。

使用流程

前置流程

1.添加依赖

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

注意：这个适用于Spring Boot版本2.6以下的(2.6版本不适用)，如果要使用更高版本的SpringBoot 必须使用更高版本的Knife4j

2.添加配置类

这个类可以放到和启动类同级的或以下的包中

import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

@Slf4j
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

    /**
     * 【重要】指定Controller包路径
     */
    private String basePackage = "src路径到你的Controller包路径";

    private String groupName