ruoyi-vue-plus配置swagger

### 关于 RuoYi-Vue-Plus 中 Swagger 配置 在 `RuoYi-Vue-Plus` 项目中集成并配置Swagger可以方便API接口的管理和测试。虽然官方文档可能未详细描述此过程，但基于Spring Boot项目的通用做法以及社区实践，以下是具体实现方法。 #### 修改依赖项 首先，在`pom.xml`文件内加入Swagger所需的相关依赖： ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> ``` 这一步骤确保了应用能够识别和加载Swagger组件[^1]。 #### 创建Swagger配置类 接着创建一个新的Java配置类用于定义Swagger的具体参数设置。通常命名为`SwaggerConfig.java`: ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; @Configuration public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.OAS_30) .apiInfo(apiInfo()) .select() // 指定要生成swagger api的包路径,可以根据自己接口位置修改basePackage中的内容 .apis(RequestHandlerSelectors.basePackage("com.ruoyi")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("RuoYi-Vue-Plus API Docs") .description("更多请关注 http://www.example.com") .termsOfServiceUrl("http://www.example.com") .contact(new Contact("name", "url", "email")) .version("1.0") .build(); } } ``` 这段代码实现了对Swagger的基础配置，包括API基本信息、扫描路径等设定。 #### 启动服务查看效果 完成上述两步之后重启应用程序即可通过访问`http://localhost:port/swagger-ui.html`(其中port为实际端口号)来浏览自动生成的API文档界面。