首先确保项目中已经引入了 Swagger 的相关依赖。如果有公共服务,可以将依赖放置在公共模块中,每个业务模块再引用该公共服务。
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-models</artifactId>
<version>1.6.2</version>
</dependency>
接着需要确保在 ruoyi-admin
模块中已经引入了新添加模块(或服务)的依赖。
<dependency>
<groupId>com.ruoyi</groupId> <!-- 包路径 -->
<artifactId>ruoyi-test</artifactId> <!-- 新模块名 -->
</dependency>
@Api
注解为需要暴露的类添加 @Api
注解,以描述该类的用途。
@Api("测试数据接口")
@ApiOperation
注解为需要暴露的接口方法添加 @ApiOperation
注解,用于描述该方法的功能。
@ApiOperation("获取测试数据列表")
重启项目后,进入 系统设置 => 系统工具 => 系统接口,即可看到新模块的 Swagger 接口文档。
提示:如果接口需要进行凭证校验,可以将系统登录后的凭证添加到 Swagger 页面中,以便进行接口测试。
如下图所示:![]()
通过以上步骤,新增模块的接口即可正常显示在 Swagger 文档中。
powered by kaifamiao