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

这篇具有很好参考价值的文章主要介绍了若依微服务swagger如何不显示某个模块的接口文档?。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

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

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

 swagger 不显示接口,若依开源框架,微服务,java,架构,若依

 默认情况下,可以看到这里包含了ruoyi-gen模块,我们要做的是,要将ruoyi-gen进行隐藏。

最终的预期结果如下图所示,可以看见,下图中,是不包含ruoyi-gen这个模块的。那我们具体应该修改哪些配置,才可以到达这种效果呢?

swagger 不显示接口,若依开源框架,微服务,java,架构,若依

 解决办法:

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

swagger 不显示接口,若依开源框架,微服务,java,架构,若依

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

我们只有去修改SwaggerProvider.java类中的代码。

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

swagger 不显示接口,若依开源框架,微服务,java,架构,若依

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

 文章来源地址https://www.toymoban.com/news/detail-728352.html

到了这里,关于若依微服务swagger如何不显示某个模块的接口文档?的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • Java技术-接口文档-Swagger2&Swagger3&接口文档UI整合

    目录 一、Swagger2完整用法 1.POM依赖 2.接口类 3.实现类 4.托管静态资源 5.接口文档配置 6.生产环境关闭接口文档 7.Swagger3页面效果 二、Swagger3完整用法 三、Swagger整合Knife4jUi 1.POM依赖 2.接口类 3.实现类 4.托管静态资源 5.接口文档配置 6.生产环境关闭接口文档 四、注释和参数讲解

    2024年02月16日
    浏览(49)
  • 怎样找到swagger接口文档

    如果你的 API 在运行中,你可以在浏览器中访问 http://[your-api-domain]/swagger 来查看 Swagger 接口文档。 例如,如果你的 API 的域名是 api.example.com ,你可以在浏览器中访问 http://api.example.com/swagger 来查看 Swagger 接口文档。 如果你的 API 是本地运行的,你可以在浏览器中访问 http://

    2024年02月16日
    浏览(38)
  • 若依微服务版(SpringBoot/SpringCloudAlibaba)中在单个服务模块中进行单元测试

    若依微服务版手把手教你本地搭建环境并运行前后端项目: 若依微服务版手把手教你本地搭建环境并运行前后端项目_霸道流氓气质的博客-CSDN博客 在上面的基础上需要在某个服务模块中进行单元测试。 注: 博客: 霸道流氓气质的博客_CSDN博客-C#,架构之路,SpringBoot领域博主

    2024年02月06日
    浏览(55)
  • Swagger接口文档的导出使用

    1.配置项目swagger2 帮助网站:https://blog.csdn.net/xhmico/article/details/125353535 配置完成后,运行项目,打开 http://localhost:8868/mike/swagger-ui.html# (注意端口) ,如下: 点击红圈链接,会生成 json 格式的接口文档,如下图: 2.生成文档 点击下方链接: 在线swagger转word文档|swagger导出w

    2024年02月09日
    浏览(43)
  • swagger接口文档导入postman

    第一步:打开接口文档并且打开控制台: 第二步:点击Network,找到api-docs的文件  第三步:将JSON格式的数据保存到本地  第四步:打开Postman,并且点击右上角的Import  第五步:将刚才的JSON格式数据粘贴复制到Raw Text  第六步:点击Continue,执行POSTman的默认选项,并且点击

    2024年02月13日
    浏览(48)
  • gin中使用swagger生成接口文档

    想要使用 gin-swagger 为你的代码自动生成接口文档,一般需要下面三个步骤: 按照swagger要求给接口代码添加声明式注释,具体参照声明式注释格式。 使用swag工具扫描代码自动生成API接口文档数据 使用gin-swagger渲染在线接口文档页面 第一步:添加注释 在程序入口main函数上以

    2024年01月25日
    浏览(42)
  • API接口文档利器:Swagger 和 接口调试利器:Postman

    2.1.1Swagger介绍 Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务 (https://swagger.io/)。 它的主要作用是: 使得前后端分离开发更加方便,有利于团队协作 接口的文档在线自动生成,降低后端开发人员编写接口文档的负担 功能测试 Spring已经

    2024年02月11日
    浏览(43)
  • SpringBoot使用Swagger2生成接口文档

            通过一下配置,将Swagger2自动配置进SpringBoot中             通过@Api注解和@ApiOperation注解说明模块作用及接口说明。         通过访问路径http://localhost:8088/doc.html,说明一下8088是我SpringBoot的端口号,你们填你们自己的,不同版本的Swagger访问的路径是不一样的。

    2024年01月25日
    浏览(45)
  • SpringBoot使用Swagger配置API接口文档

    Swagger是一个用于设计、构建和文档化 RESTful API 的开源框架。它提供了一组工具,使得开发人员能够更轻松地定义、描述和测试API接口。 具体来说,Swagger包含以下几个核心组件: Swagger规范(Swagger Specification): 定义了一种格式化的API规范,使用YAML或JSON格式,用于描述API的各

    2024年02月05日
    浏览(49)
  • FastAPI 自动文档Swagger UI 打不开。显示空白

    这两个文件红了。 1.下载文件 这两个文件的开源项目地址如下 https://github.com/swagger-api/swagger-ui https://github.com/Redocly/redoc 我们只需要提前自己需要的文件即可 这里已经从中抽取出来所需要的文件,需要的可以点击下方连接自行下载 静态文件直达 百度网盘链接: https://pan.baidu

    2024年02月11日
    浏览(51)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包