若依框架前后端分离版v3.8.3使用代码生成工具生成的接口无法通过swagger访问

       若依框架前后端分离版v3.8.3使用代码生成工具生成的接口无法通过swagger访问;然后发现自己的接口里没有添加swagger注解,也就是说使用若依自带的代码生成工具生成的代码里controller接口是没有添加swagger注解的,这就很不爽了,总不能每个接口都自己添加吧!那就修改生成代码的模板,实现自动添加,话不多说,上干货!

一、修改生成代码模板

修改这个文件ruoyi-generator\src\main\resources\vm\java\controller.java.vm:

 

 如图,主要修改三个地方:

1、导入swagger的包路径:

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;

2、在类名上添加@Api注解,注解的值可以取类名的注释;

3、在方法名上添加@ApiOperation注解,注解的值可以取方法名的注释;

重启项目,重新生成代码。

二、修改swagger pom依赖的位置

 

生成的代码导入IDE后报错,是因为我新建的这个模块,没有引入swagger的依赖y,为了以后其它新增的module都不用再单独引入swagger依赖,将swagger的pom依赖放到ruoyi-common的pom中,那么将ruoyi-admin中的swagger依赖剪切并复制到ruoyi-common的pom中:

<!-- swagger3-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
</dependency>

<!-- 防止进入swagger页面报类型转换错误,排除3.0.0中的引用,手动增加1.6.2版本 -->
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-models</artifactId>
<version>1.6.2</version>
</dependency>

 三、接口调用

在系统接口页面通过swagger调用接口报401错误,

 这是因为接口设置了权限控制的原因,

 那就得设置请求头认证了,随便点击一个页面获取到Admin-Token的值

 然后到swagger页面复制并粘贴到下图那里,再点击Authorize按钮即可。

 

若依框架访问Swagger的方法有多种。根据引用内容,你可以尝试以下解决方法: 1. 确保你的启动类上添加了`@EnableSwagger2`注解或`@EnableOpenApi`注解。这两个注解都可以用于启用Swagger的功能。 2. 确保你的模块中引入了Swagger的依赖。根据引用\[2\]中的内容,你可以将Swagger的依赖放到`ruoyi-common`模块的pom文件中,然后将`ruoyi-admin`模块中的Swagger依赖剪切并复制到`ruoyi-common`的pom文件中。 3. 如果你遇到了访问Swagger页面报类型转换错误的问题,可以尝试在Swagger的依赖中排除本为3.0.0的引用,并手动增加本为1.6.2的引用。具体操作可以参考引用\[2\]中的内容。 4. 如果你使用了Shiro框架,并且遇到了访问Swagger页面需要登录的问题,可以在`ShiroConfig.java`文件的`shiroFilterFactoryBean`方法内增加相应的代码,如引用\[3\]中所示。这样可以配置不需要登录即可访问Swagger的相关路径。 综上所述,根据你的具体情况,你可以尝试以上方法来解决若依框架访问Swagger的问题。 #### 引用[.reference_title] - *1* [若依框架在未登录的情况下访问swagger3.0页面,出现弹窗的解决方法](https://blog.csdn.net/huanloveqiang/article/details/130865611)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insert_down1,239^v3^insert_chatgpt"}} ] [.reference_item] - *2* [若依框架前后端分离v3.8.3使用代码生成工具生成接口无法通过swagger访问](https://blog.csdn.net/NDF923/article/details/126178066)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insert_down1,239^v3^insert_chatgpt"}} ] [.reference_item] - *3* [若依框架在未登录的情况下访问swagger页面](https://blog.csdn.net/qq_19309473/article/details/119810675)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insert_down1,239^v3^insert_chatgpt"}} ] [.reference_item] [ .reference_list ]
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

码道功成

过程不易,恳请支持一下!

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值