SpringBoot整合Swagger-Bootstrap-UI实现接口文档

"本文档介绍了如何在Spring Boot项目中集成Swagger-Bootstrap-UI，这是一个用于生成接口文档的前端框架。Swagger-Bootstrap-UI是Swagger的一个美化版本，提供了更友好的界面和更多的定制选项。" 在Spring Boot应用中集成Swagger-Bootstrap-UI，首先需要添加必要的依赖到项目的`pom.xml`文件。以下是两个关键的Maven依赖： 1. `springfox-swagger2`: 这是Springfox的核心库，提供了构建API文档的基础结构。 2. `swagger-bootstrap-ui`: 这是Swagger-Bootstrap-UI的依赖，它提供了一个更美观的用户界面来展示和测试API。 ```xml <!--swagger-api依赖开始--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>swagger-bootstrap-ui</artifactId> <version>1.9.2</version> </dependency> <!--swagger-api依赖结束--> ``` 接下来，你需要在项目中创建一个配置文件，通常命名为`swaggerConfig.java`，并放置在一个合适的包下（例如，`com.xiaomin.config`）。这个配置文件将定义Swagger的设置，如API的信息、扫描的包以及暴露的路径。 ```java @Configuration @EnableWebMvc @ComponentScan(basePackages = "com.xiaomin") // 替换为你的项目包名 public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() // 扫描的包，这里指定你的Controller所在包 .apis(RequestHandlerSelectors.basePackage("com.xiaomin.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Spring Boot RESTful API") .description("这是一个Spring Boot集成Swagger-Bootstrap-UI的示例") .version("1.0.0") .contact(new Contact("xiaomin", "https://doc.xiaominfo.com/", "[email protected]")) .license("Apache 2.0") .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html") .build(); } } ``` 在这个配置中，`createRestApi`方法定义了Docket，它是一个配置对象，用于控制哪些API被包含在文档中。`apiInfo`方法用来设置API的基本信息，如标题、描述、版本等。 完成这些步骤后，你可以启动Spring Boot应用，并访问Swagger-Bootstrap-UI的默认路径（通常是`http://localhost:8080/swagger-ui.html`），查看和测试你的API接口。 通过Swagger-Bootstrap-UI，开发者可以方便地查看API的详细信息，包括端点、参数、响应状态等，同时提供了一个交互式的测试环境，使得测试和调试API变得更加简单。这在协作开发或者对外提供API时，极大地提高了效率和用户体验。