开发喵星球

若依新增模块 Swagger 无法扫描到接口解决方案(307)

1. 添加 Swagger 依赖

首先确保项目中已经引入了 Swagger 的相关依赖。如果有公共服务,可以将依赖放置在公共模块中,每个业务模块再引用该公共服务。

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-models</artifactId>
    <version>1.6.2</version>
</dependency>

2. 确认 ruoyi-admin 模块依赖

接着需要确保在 ruoyi-admin 模块中已经引入了新添加模块(或服务)的依赖。

<dependency>
    <groupId>com.ruoyi</groupId> <!-- 包路径 -->
    <artifactId>ruoyi-test</artifactId> <!-- 新模块名 -->
</dependency>

3. 为接口添加注解

1. 在类上添加 @Api 注解

为需要暴露的类添加 @Api 注解,以描述该类的用途。

@Api("测试数据接口")

2. 在方法上添加 @ApiOperation 注解

为需要暴露的接口方法添加 @ApiOperation 注解,用于描述该方法的功能。

@ApiOperation("获取测试数据列表")

4. 检查结果

重启项目后,进入 系统设置 => 系统工具 => 系统接口,即可看到新模块的 Swagger 接口文档。

提示:如果接口需要进行凭证校验,可以将系统登录后的凭证添加到 Swagger 页面中,以便进行接口测试。
如下图所示:

通过以上步骤,新增模块的接口即可正常显示在 Swagger 文档中。

   
分类:Java/OOP 作者:无限繁荣, 吴蓉 发表于:2024-08-21 16:12:06 阅读量:270
<<   >>


powered by kaifamiao