JeecgBoot 如何在生产环境关闭 Swagger 文档
ccwgpt 2024-10-28 15:02 46 浏览 0 评论
为了生产安全，我们需要在生产环境关闭 JeecgBoot 的 Swagger 文档功能。
介绍
JeecgBoot 作为一个低代码开发平台，可以自动生成 OpenAPI 标准的 RESTful 协议的接口文档，方便前后端分离式的开发模式，进行前后端对接，以及接口调试。
不过由于该开发通常情况下来说，仅限于开发环境、测试环境，不适用于生产环境、线上环境等，因为该文档存在暴露系统内部信息的风险，一旦被有心之人利用，有可能会造成生产危机。
所以本文将为大家介绍，如何在 JeecgBoot 框架中，在生产环境对接口文档进行快捷禁用。
单体模式
JeecgBoot 框架默认提供了三种 profile 的配置文件，分别是 dev、test、prod，分别对应开发环境、测试环境、生产环境，在 prod 配置文件中配置了用于关闭 swagger 接口文档的配置
knife4j.production=true另外还有一个共用的 application.yml 配置文件，其中有一个 spring.profiles.active 的配置项，通过修改该值，即可指定当前系统采用什么模式启动。
不过我们可以看到默认值为 @profile.name@，这是 JeecgBoot 为了方便大家在进行 maven 打包时指定以什么模式打包，而不需要去修改配置文件中的配置项。
在图的右上方我们可以看到 maven 工具面板上 profile 栏中，列举了 dev、test、prod 共 4 个 profile，我们可以选择其中一个进行打勾，再点击下方 clean 命令、package 命令即可。
最后，启动运行后，我们再尝试访问接口文档地址：
http://localhost:8080/jeecg-boot/doc.html
发现页面的无法响应，不再是接口文档，而是一个没有任何接口信息的白页。
微服务模式
在微服务模式中，完全继承单体模式的关闭接口文档的配置，不过不同的是，由于微服务模式下服务数量不可估量，如果有 N 个服务，那就会有 N 个服务的接口文档地址，这样使用下来，未免太可繁琐。 JeecgBoot 考虑到了这点，结合微服务模式中的 gateway 服务，将所有子服务的接口文档进行聚合，聚合后可通过一个地址即可访问所有服务的接口文档。
不过也正是因为这个功能，所以我们在关闭接口文档时，除了沿用单体模式的操作之外，也需要额外多加一个针对 gateway 服务的处理，需要在 gateway 服务的配置文件中，添加配置。
knife4j.production=true再次访问聚合接口文档地址： http://localhost:9999/doc.html
相关推荐
- 用Steam启动Epic游戏会更快吗?（epic怎么用steam启动）
-
Epic商店很香，但也有不少抱怨，其中一条是启动游戏太慢。那么，如果让Steam启动Epic游戏，会不会速度更快？众所周知，Steam可以启动非Steam游戏，方法是在客户端左下方点击“添加游戏”，然...
- Docker看这一篇入门就够了（dockerl）
-
安装DockerLinux:$curl-fsSLhttps://get.docker.com-oget-docker.sh$sudoshget-docker.sh注意：如果安装了旧版...
- AYUI 炫丽PC开发UI框架2016年6月15日对外免费开发使用 [1]
-
2016年6月15日，我AY对外发布AYUI（WPF4.0开发）的UI框架，开发时候，你可以无任何影响的去开发PC电脑上的软件exe程序。AYUI兼容XP操作系统，在Win7/8/8.1/10上都顺利...
- 别再说C#/C++套壳方案多了!Tauri这“借壳生蛋”你可能没看懂!
-
浏览器套壳方案，C#和C++有更多，你说的没错，从数量和历史积淀来看，C#和C++确实有不少方式来套壳浏览器，让Web内容在桌面应用里跑起来。但咱们得把这套壳二字掰扯清楚，因为这里面学问可大了！不同的...
- OneCode 核心概念解析——Page(页面)
-
在接触到OneCode最先接触到的就是，Page页面，在低代码引擎中，页面（Page）设计的灵活性是平衡“快速开发”与“复杂需求适配”的关键。以下从架构设计、组件系统、配置能力等维度，解析确...
- React是最后的前端框架吗，为什么这么说的?
-
油管上有一位叫Theo的博主说，React是终极前端框架，为什么这么说呢？让我们来看看其逻辑：这个标题看起来像假的，对吧？React之后明明有无数新框架诞生，凭什么说它是最后一个？我说的“最后一个”不...
- 面试辅导(二):2025前端面试密码:用3个底层逻辑征服技术官
-
面试官放下简历，手指在桌上敲了三下："你上次解决的技术难题，现在回头看有什么不足？"眼前的候选人瞬间僵住——这是上周真实发生在蚂蚁金服终面的场景。2025年的前端战场早已不是框架熟练...
- 前端新星崛起!Astro框架能否终结React的霸主地位?
-
引言：当"背着背包的全能选手"遇上"轻装上阵的短跑冠军"如果你是一名前端开发者，2024年的框架之争绝对让你眼花缭乱——一边是React这位"背着全家桶的全能选...
- 基于函数计算的 BFF 架构（基于函数计算的 bff 架构是什么）
-
什么是BFFBFF全称是BackendsForFrontends(服务于前端的后端)，起源于2015年SamNewman一篇博客文章《Pattern:BackendsFor...
- 谷歌 Prompt Engineering 白皮书:2025年 AI 提示词工程的 10 个技巧
-
在AI技术飞速发展的当下，如何更高效地与大语言模型（LLM）沟通，以获取更准确、更有价值的输出，成为了一个备受关注的问题。谷歌最新发布的《PromptEngineering》白皮书，为这一问题提供了...
- 光的艺术:灯具创意设计（灯光艺术作品展示）
-
本文转自|艺术与设计微信号|artdesign_org_cn“光”是文明的起源，是思维的开端，同样也是人类睁眼的开始。每个人在出生一刻，便接受了光的照耀和洗礼。远古时候，人们将光奉为神明，用火来...
- MoE模型已成新风口，AI基础设施竞速升级
-
机器之心报道编辑：Panda因为基准测试成绩与实际表现相差较大，近期开源的Llama4系列模型正陷入争议的漩涡之中，但有一点却毫无疑问：MoE（混合专家）定然是未来AI大模型的主流范式之一。...
- Meta Spatial SDK重大改进:重塑Horizon OS应用开发格局
-
由文心大模型生成的文章摘要Meta持续深耕SpatialSDK技术生态，提供开自去年9月正式推出以来，Meta持续深耕其SpatialSDK技术生态，通过一系列重大迭代与功能增强，不断革新H...
- "上云"到底是个啥?用"租房"给你讲明白IaaS/PaaS/SaaS的区别
-
半夜三点被机房报警电话惊醒，顶着黑眼圈排查服务器故障——这是十年前互联网公司运维的日常。而现在，程序员小王正敷着面膜刷剧，因为公司的系统全"搬"到了云上。"部署到云上"...
- php宝塔搭建部署thinkphp机械设备响应式企业网站php源码
-
大家好啊，欢迎来到web测评。本期给大家带来一套php开发的机械设备响应式企业网站php源码，上次是谁要的系统项目啊，帮你找到了，还说不会搭建，让我帮忙录制一期教程，趁着今天有空，简单的录制测试了一下...
欢迎 你 发表评论:
- 一周热门
- 最近发表
-
- 用Steam启动Epic游戏会更快吗?（epic怎么用steam启动）
- Docker看这一篇入门就够了（dockerl）
- AYUI 炫丽PC开发UI框架2016年6月15日对外免费开发使用 [1]
- 别再说C#/C++套壳方案多了!Tauri这“借壳生蛋”你可能没看懂!
- OneCode 核心概念解析——Page(页面)
- React是最后的前端框架吗，为什么这么说的?
- 面试辅导(二):2025前端面试密码:用3个底层逻辑征服技术官
- 前端新星崛起!Astro框架能否终结React的霸主地位?
- 基于函数计算的 BFF 架构（基于函数计算的 bff 架构是什么）
- 谷歌 Prompt Engineering 白皮书:2025年 AI 提示词工程的 10 个技巧
- 标签列表
-
- 框架图 (58)
- flask框架 (53)
- quartz框架 (51)
- abp框架 (47)
- jpa框架 (47)
- springmvc框架 (49)
- 分布式事务框架 (65)
- scrapy框架 (56)
- shiro框架 (61)
- 定时任务框架 (56)
- java日志框架 (61)
- JAVA集合框架 (47)
- mfc框架 (52)
- abb框架断路器 (48)
- ui自动化框架 (47)
- beego框架 (52)
- java框架spring (58)
- grpc框架 (55)
- ppt框架 (48)
- 内联框架 (52)
- cad怎么画框架 (58)
- ps怎么画框架 (47)
- ssm框架实现登录注册 (49)
- oracle字符串长度 (48)
- oracle提交事务 (47)