ruoyi-plue 中的SpringDoc

<think>嗯，用户想了解Ruoyi-Plus中的SpringDoc。首先，我需要回忆一下Ruoyi-Plus是什么，它是一个基于Spring Boot的快速开发框架，可能是在若依框架基础上的增强版。SpringDoc应该是用来生成API文档的工具，类似Swagger，但支持OpenAPI 3.0。 接下来，我需要确定用户的具体需求。他们可能是在使用Ruoyi-Plus时遇到了集成API文档的问题，或者想了解如何利用SpringDoc来自动生成文档。需要分步骤介绍SpringDoc在Ruoyi-Plus中的应用，包括配置、注解使用、访问路径等。 然后，考虑用户可能的疑问点，比如如何引入依赖、配置类的作用、常用注解，以及如何访问生成的文档。确保回答结构清晰，分点说明，并给出实际代码示例，比如配置类和控制器注解的使用。同时，需要注意Ruoyi-Plus可能有自己的安全配置，需要排除SpringDoc的路径，避免被拦截。 还要检查是否需要对比SpringDoc和Swagger的区别，说明为什么选择SpringDoc，可能因为对OpenAPI 3.0的支持更好。另外，提醒用户注意版本兼容性和生产环境的关闭建议，这些都是实际开发中容易遇到的问题。 最后，确保使用中文，符合格式要求，数学公式正确使用$...$和$$...$$，但在这里可能用不上数学公式，不过要检查是否有其他格式要求。保持回答简洁明了，帮助用户一步步解决问题，并确保信息准确可靠。</think>在Ruoyi-Plus框架中，SpringDoc的集成与使用可以通过以下步骤理解： --- ### 一、SpringDoc基础概念 SpringDoc是基于OpenAPI 3规范的开源工具，用于自动生成API文档（替代传统的Swagger）。在Ruoyi-Plus中主要用于： 1. 自动扫描控制器生成可视化API文档 2. 支持在线测试接口 3. 提供交互式文档界面 --- ### 二、Ruoyi-Plus中的配置实现 #### 1. 依赖引入 ```xml <!-- pom.xml中需包含 --> <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>2.1.0</version> </dependency> ``` #### 2. 配置类示例 ```java @Configuration public class OpenApiConfig { @Bean public OpenAPI ruoyiPlusOpenAPI() { return new OpenAPI() .info(new Info().title("Ruoyi-Plus API") .description("企业级开发框架接口文档") .version("v1.0") .contact(new Contact().name("技术支持"))); } } ``` #### 3. 安全配置排除（重要） 在SecurityConfig中添加： ```java .antMatchers("/swagger-ui/**", "/v3/api-docs/**").permitAll() ``` --- ### 三、核心注解使用 在Controller层使用： ```java @Tag(name = "用户管理模块") @RestController @RequestMapping("/system/user") public class SysUserController { @Operation(summary = "获取用户列表") @GetMapping("/list") public TableDataInfo list(SysUser user) { // ... } @Parameter(name = "userId", description = "用户ID", required = true) @GetMapping("/{userId}") public AjaxResult getInfo(@PathVariable Long userId) { // ... } } ``` --- ### 四、文档访问路径 1. **API JSON描述**：`http://localhost:port/v3/api-docs` 2. **可视化界面**：`http://localhost:port/swagger-ui.html` --- ### 五、与Swagger的区别 | 特性 | SpringDoc | Swagger | |---------------------|---------------------|--------------------| | OpenAPI版本支持 | 3.0+ | 2.0 | | Spring Boot集成 | 原生支持 | 需要额外配置 | | 注解包路径 | `io.swagger.v3` | `io.swagger` | --- ### 六、注意事项 1. **版本兼容性**：需与Spring Boot版本匹配 2. **生产环境**：建议通过`springdoc.swagger-ui.enabled=false`关闭 3. **权限控制**：结合Ruoyi-Plus的@RequiresLogin注解实现访问控制 通过上述配置，Ruoyi-Plus可以快速生成符合OpenAPI 3规范的接口文档，提升前后端协作效率。实际使用中建议结合具体业务需求扩展文档描述信息。