SpringBoot常用插件-Knife4j(自动生成接口查看调试页面)

Knife4j简介

基础ui组件(自定义文档、动态参数调试、I18n、接口排序、导出等)
基于Springfox框架+Swagger2规范的自动注入starter
基于Springdoc-openapi+OAS3规范的自动注入starter
提供对主流网关组件的统一聚合OpenAPI接口文档的解决方案

简单来说，就是在Swagger和OpenAPI基础上，提供了更简单的使用方法，更好的界面。
下面，基于SpringBoot2+OpenAPI2进行操作示例

示例

1. pom.xml文件中导入依赖

<!--引入Knife4j的官方start包,该指南选择Spring Boot版本<3.0,开发者需要注意-->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
    <version>4.0.0</version>
</dependency>

2. 创建一个配置文件 Knife4jConfiguration.java，自动装配后就会根据路径去扫描配置的文件

@Configuration
@EnableSwagger2WebMvc
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

    @Bean(value = "dockerBean")
    public Docket dockerBean() {
        //指定使用Swagger2规范
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        //描述字段支持Markdown语法
                        .description("api组名称")
                        .termsOfServiceUrl("地址")
                        .contact("过期函数")
                        .version("1.0")
                        .build())
                //分组名称
                .groupName("用户服务")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.yun"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}

3. 对需要展示的Controller和Model添加注解

@RestController
@RequestMapping("/Hello")
@Api(tags = "helloApi")
public class HelloController {

    @ApiImplicitParam(name = "word",value = "说出想要说的话",required = true)
    @ApiOperation(value = "向世界问号")
    @RequestMapping
    public String helloWorld(String word){

        return "对世界说："+word;
    }

}

@ApiModel("用户")
@Data
public class UserModel {
    @ApiModelProperty("名称")
    private String name;
    @ApiModelProperty("密码")
    private String password;
}

注意：这时可能会出现Failed to start bean 'documentationPluginsBootstrapper';的错误
这是由于Springfox使用的路径匹配是基于AntPathMatcher的，而Spring Boot 2.6.X使用的是PathPatternMatcher。
解决办法：在你的主配置文件中，配置：

#properties配置
spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER

#yml配置
spring:
	mvc:
     pathmatch:
     		 matching-strategy: ANT_PATH_MATCHER

4.打开网站
地址：ip:host/项目名称/doc.html
例如： http://localhost:8080/doc.html