以前 Knife4j 还是 Swagger 的一个前端皮肤，现在已经变成了一个增强解决方案了

这个是 Knife4j 官方的介绍：Knife4j 是一个集 Swagger2 和 OpenAPI3 为一体的增强解决方案

https://doc.xiaominfo.com/ 是 Knife4j 的官方地址。

快速入门很简单，直接看官方文档吧：https://doc.xiaominfo.com/docs/action/springboot

Model 名称重名解决

Model 名称自动防止重名：比如前面使用 Swagger 的时候遇到的重名 文档，Knife4j 也存在这个问题

只不过 Knife4j 对 model 的命名有要求，类全限定名称里面有特殊符号 . 把它换一下就行了。
比如下面这个配置

  1.     // ~ swagger API 文档 ==========================
  2.     implementation "io.springfox:springfox-boot-starter:3.0.0"
  3.     implementation 'com.github.xiaoymin:knife4j-spring-boot-starter:2.0.9'
  1. package cn.mrcode.autoconfig;
  3. import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
  4. import org.springframework.beans.factory.annotation.Autowired;
  5. import org.springframework.context.annotation.Bean;
  6. import org.springframework.context.annotation.Configuration;
  7. import springfox.documentation.builders.ApiInfoBuilder;
  8. import springfox.documentation.builders.PathSelectors;
  9. import springfox.documentation.builders.RequestHandlerSelectors;
  10. import springfox.documentation.spi.DocumentationType;
  11. import springfox.documentation.spi.schema.TypeNameProviderPlugin;
  12. import springfox.documentation.spring.web.plugins.Docket;
  13. import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
  15. /**
  16.  * @author mrcode
  17.  * @date 2022/11/2 19:35
  18.  */
  19. @Configuration
  20. @EnableSwagger2WebMvc
  21. public class Knife4jConfiguration {
  22.     /*引入Knife4j 提供的扩展类*/
  23.     private final OpenApiExtensionResolver openApiExtensionResolver;
  25.     @Autowired
  26.     public Knife4jConfiguration(OpenApiExtensionResolver openApiExtensionResolver) {
  27.         this.openApiExtensionResolver = openApiExtensionResolver;
  28.     }
  30.     @Bean(value = "defaultApi2")
  31.     public Docket defaultApi2() {
  32.         Docket docket = new Docket(DocumentationType.SWAGGER_2)
  33.                 .apiInfo(new ApiInfoBuilder()
  34.                         .title("系统 RESTful APIs")
  35.                         .description("API 文档")
  36.                         //.termsOfServiceUrl("http://www.xx.com/")
  37.                         .version("1.0")
  38.                         .build())
  39.                 //分组名称
  40. //                .groupName("2.X版本")
  41.                 .select()
  42.                 //这里指定Controller扫描包路径
  43.                 .apis(RequestHandlerSelectors.basePackage("cn.mrcode.web.controller"))
  44.                 .paths(PathSelectors.any())
  45.                 .build()
  46.                 //赋予插件体系
  47.                 .extensions(openApiExtensionResolver.buildExtensions("default"));
  48.         ;
  49.         return docket;
  50.     }
  52.     @Bean
  53.     public TypeNameProviderPlugin typeNameProviderPlugin() {
  54.         return new MyTypeNameProviderPlugin();
  55.     }
  56. }
  1. package cn.mrcode.autoconfig;
  3. import org.springframework.core.annotation.Order;
  4. import springfox.documentation.spi.DocumentationType;
  5. import springfox.documentation.spi.schema.TypeNameProviderPlugin;
  6. import springfox.documentation.swagger.common.SwaggerPluginSupport;
  8. /**
  9.  * @author mrcode
  10.  * @date 2022/11/2 17:50
  11.  */
  12. @Order(SwaggerPluginSupport.SWAGGER_PLUGIN_ORDER - 100)
  13. public class MyTypeNameProviderPlugin implements TypeNameProviderPlugin {
  14.     @Override
  15.     public String nameFor(Class<?> type) {
  16.         // 这里将特殊字符 .  换成下划线
  17.         return type.getName().replaceAll("\\.", "_");
  18.     }
  20.     @Override
  21.     public boolean supports(DocumentationType delimiter) {
  22.         return true;
  23.     }
  24. }

下面是 yml 中的配置（其实不太重要，和本次要解决的重名问题没有任何关系，算是一个入门 demo 吧）

  1. knife4j:
  2.   enable: true
  3.   # 生产环境屏蔽资源
  4.   production: false
  5.   documents:
  6.     - name: 使用 API 必读
  7.       locations: classpath:api-markdowns/*

model 命名的不同下面截图有比较
![NVRRPTVG4W$}R6(UT1CW[8.png](https://cdn.nlark.com/yuque/0/2022/png/651749/1667439480616-69855c0f-7ba9-4b28-abec-4becd6f3b2c0.png#averageHue=%23fdfcfc&clientId=u98f12cef-38bb-4&crop=0&crop=0&crop=1&crop=1&errorMessage=unknown%20error&from=paste&height=708&id=ub861dcc4&margin=%5Bobject%20Object%5D&name=NVRRPT%60VG4W%24%7DR6%28UT1CW%5B8.png&originHeight=885&originWidth=1568&originalType=binary&ratio=1&rotation=0&showTitle=false&size=171950&status=error&style=none&taskId=ucd076dcd-bb84-4046-842a-d4c12140c1f&title=&width=1254.4)<br />通过对比发现：只要$ref值没有#/definitions`开头的路径，在下图的请求参数和响应参数里面就看不到具体的参数信息。
image.png