JeecgBoot 如何在生产环境关闭 Swagger 文档

为了生产安全,我们需要在生产环境关闭 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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,602评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,442评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,878评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,306评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,330评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,071评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,382评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,006评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,512评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,965评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,094评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,732评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,283评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,286评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,512评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,536评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,828评论 2 345

推荐阅读更多精彩内容