如何配置knife4j

Knife4J是一个用于快速生成文档的注解工具，通常集成到Spring Boot项目中。以下是配置Knife4J的基本步骤：

1. 添加依赖：首先，在你的`pom.xml`文件中添加Knife4J的Maven坐标：

   <dependency>
       <groupId>com.github.ruediste</groupId>
       <artifactId>knife4j-spring-boot-starter</artifactId>
       <version>最新版本号</version>
   </dependency>

确保替换`最新版本号`为最新的稳定版本。

2. 配置启动类：如果你使用的是Spring Boot，可以在`@SpringBootApplication`上添加`@EnableSwagger2`注解开启Swagger支持，并启用Knife4J：

   @SpringBootApplication
   @EnableSwagger2
   public class Application {
       // ...
   }

3. 注解说明：为了自动生成API文档，需要在控制器类或方法上添加Swagger注解，如`@ApiOperation`、`@ApiParam`等。例如：

   @RestController
   @RequestMapping("/api")
   public class YourController {

       @GetMapping("/example")
       @ApiOperation("获取示例")
       public String exampleEndpoint() {
           return "Hello";
       }
   }

4. 配置扫描路径：如果需要扫描特定包下的API，可以配置Swagger扫描器：

   @Bean
   public WebMvcSwagger2ConfigProvider webMvcSwagger2ConfigProvider() {
       return new WebMvcSwagger2ConfigProviderBuilder()
               .apiInfo(apiInfo())
               .includePatterns(".*\\.yourpackage\\.YourController") // 替换为你需要扫描的包名
               .build();
   }

5. 服务器端口和资源前缀：在`application.properties`或`application.yml`中设置Swagger的端口和资源前缀，比如：

   server.port=8082
   swagger.path=/swagger-ui

6. 部署运行：最后，运行你的应用，访问`http://localhost:8082/swagger-ui`即可查看生成的API文档。