Java集成swagger和knife4j

### Java项目中集成Swagger和Knife4j 在Java项目中，特别是基于Spring Boot的应用程序，可以通过引入Swagger和其增强版本Knife4j来实现API文档的自动生成与管理。这不仅提高了开发效率，还增强了API的可读性和易用性。 #### 添加依赖项 对于Maven构建工具，在`pom.xml`文件内加入如下依赖： ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> <!-- Knife4j扩展 --> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>3.0.3</version> </dependency> ``` 这些依赖会自动配置好Swagger UI以及提供更美观友好的前端展示效果[^1]。 #### 配置Swagger 创建一个名为`SwaggerConfig.java`的新类用于初始化Swagger设置： ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; @Configuration public class SwaggerConfig { @Bean(value = "defaultApi2") public Docket defaultApi2() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(new ApiInfoBuilder() .title("API Documentation") // 文档标题 .description("Description of APIs") // 描述 .contact(new Contact("Name", "", "")) .license("") .licenseUrl("") .version("1.0") .build()) .select() /* 定义扫描包路径 */ .apis(RequestHandlerSelectors.basePackage("com.example.controller")) .paths(PathSelectors.any()) .build(); } } ``` 这段代码定义了一个Docket Bean实例并设置了基本的信息如标题、描述等，并指定了要被解析成API接口的方法所在的包位置。 #### 启动应用后的访问地址 完成上述步骤后启动应用程序，默认情况下可以在浏览器输入以下URL查看生成的API文档页面: - **Swagger UI**: `http://localhost:8080/swagger-ui/index.html` - **Knife4j Enhanced UI**: `http://localhost:8080/doc.html` 这两个链接分别指向原始版和美化过的UI界面，其中后者提供了更多实用功能比如在线调试请求参数等功能。 通过这种方式能够快速有效地为现有的RESTful服务添加详细的交互式文档支持，极大地简化了前后端协作流程中的沟通成本。