若依微服务项目09 - swagger如何不显示某个模块的接口文档

在若依微服务项目中,如果不想暴露某个模块的swagger的接口文档,需要怎么做?

本文以ruoyi-gen模块进行举例说明。

 

默认情况下,可以看到这里包含了ruoyi-gen模块,我们要做的是,要将ruoyi-gen进行隐藏。
最终的预期结果如下图所示,可以看见,下图中,是不包含ruoyi-gen这个模块的。

 

解决办法:

要实现这个效果,其实不难。
这个列表的数据是来源于ruoyi-gateway-dev.yml中的定义的模块。

但是实现这个效果,单纯的通过nacos配置文件修改是没有办法达到的。

需要去修改SwaggerProvider.java类中的代码。

具体位置:ruoyi-gateway/src/main/java/com/ruoyi/gateway/config/SwaggerProvider.java

 

 

修改完成之后,重启网关服务,即可达到预期的效果了。

  • 8
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 2
    评论
若依微服务是一种基于Spring Cloud微服务架构,它提供了一套完整的解决方案来快速构建和部署分布式系统。Swagger文档是一种用于描述和展示API接口的工具,可以方便开发人员和测试人员理解和调用接口。 在若依微服务,可以通过更换Swagger文档来实现以下几个方面的需求: 1. 支持更多的API文档格式:目前,Swagger文档使用的是OpenAPI规范,可以方便地生成和展示API接口文档。但是有时候,我们可能需要支持其他类型的API文档格式,比如RAML、API Blueprint等。通过更换Swagger文档,我们可以灵活选择适合自己的API文档格式。 2. 自定义API文档样式:Swagger文档默认提供了一套简洁的样式和布局,但是它可能不符合我们的品牌和设计要求。通过更换Swagger文档,我们可以自定义API文档的样式,包括颜色、字体、布局等,以适应我们的品牌形象。 3. 扩展API文档功能:Swagger文档提供了一些基本的功能,比如生成API文档、调试接口、测试接口等。但是在实际应用,我们可能需要更多的功能来满足特定的需求,比如权限控制、数据模型关联等。通过更换Swagger文档,我们可以集成其他的API文档工具或者自行开发插件来扩展API文档的功能。 总之,若依微服务更换Swagger文档可以帮助我们实现更多定制化和扩展性的需求,从而更好地满足项目的特定要求。通过更换Swagger文档,我们可以选择适合自己的API文档格式、样式和功能,提高团队的开发效率和项目的可维护性。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

全能技术师

相关资源在博客首页资源下获取

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

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

打赏作者

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

抵扣说明:

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

余额充值