使用Knife4jAggregationDesktop(连接nacos方式),聚合Swagger 3文档

最近在捣鼓Spring Boot 3.0,虽然每个微服务中的Swagger都配置好了,但要记住每个微服务的IP和端口来访问是有点不方便的。之前在Spring Boot 2.X时候,用过Spring Cloud Gateway中聚合来展示觉得还不错,但是升级之后就报错。看了knife4j的官方文档,发现目前在Spring Cloud Gateway中只支持knife4j的swagger v2版本。

用Spring Cloud Gateway聚合swagger v3不行,那就试下官方介绍的Knife4jAggregationDesktop方式吧!Desktop顾名思义就是桌面版,但是官方不提供jar包,需要用docker来安装。官方也有提供教程,但是看起来有复杂,这里只是针对连接nacos方式的更简单易懂的教程。

一、Docker环境准备

Linux 下可以使用docker或者podman;Windows下可以使用Docker Desktop (之前有写过一篇文章:https://www.jianshu.com/p/d95680ad520a ,关于安装Docker Desktop)。安装过程,这里不多说了,本次使用的Linux下docker。

二、运行容器

使用下面的命令下载docker镜像:

docker pull xiaoymin/knife4j:v2.0

下载完成后,然后新建一个目录用于存放配置文件,我建的目录是:/opt/knife4j,然后运行下面的命令启动容器:

docker run -e knife4j.source=disk -e knife4j.disk.dir="/knife4j/data" -p 10000:10000 -v /opt/knife4j:/knife4j/data --name knife -d xiaoymin/knife4j:v2.0

说明一下,-e knife4j.source=disk-e knife4j.disk.dir="/knife4j/data" 这两个参数是改写环境变量,将配置信息保存在容器中的/knife4j/data目录下,-v /opt/knife4j:/knife4j/data是将容器中的目录映射到宿主机的目录(前面创建的/opt/knife4j目录),-p 10000:10000这个将容器的端口映射出来,--name knife指定容器的名称。

然后再执行下面的命令查看容器是否运行成功,如果有开启防火墙的话,还要打开宿主机的相关端口:

docker ps -a
#打开防火墙端口,CentOS
firewall-cmd --zone=public --permanent --add-port=10000/tcp
firewall-cmd --reload

然后在你的浏览器中输入 http://【宿主机IP】:10000/doc.html 并回车,看到如下页面即为成功运行。

三、配置聚合

上图看到的只是一个默认的示例文档,想要聚合显示多个微服务的Swagger文档,还需要配置。这里介绍的是通过连接nacos获取微服务的方式聚合,优点就是修改了微服务的IP和端口也不用修改配置文件。

进入宿主机的/opt/knife4j目录,发现多了一个ROOT目录,进入这个ROOT目录,下面有一个default.yml文件,这就是默认的示例配置,可以删除掉这个文件。

ROOT目录下新建一个nacos.properties文件,注意文件的编码要是UTF-8格式,否则会引起乱码。可以在Windows中建好文件,再复制过去,nacos.properties文件内容如下:

# 配置nacos的IP地址和端口号
knife4j.nacos[0].server=192.168.50.26:8848
# 配置nacos的登录账号和密码
knife4j.nacos[0].username=nacos
knife4j.nacos[0].password=nacos
# 配置微服务所在的命名空间
knife4j.nacos[0].namespace=elwin

# 配置第一个微服务的文档
# 文档中显示的服务名
knife4j.nacos[0].routes[0].name=用户及系统
# nacos中注册的服务名
knife4j.nacos[0].routes[0].serviceName=EzLcp-User
# nacos中服务所以的分组名
knife4j.nacos[0].routes[0].groupName=DEFAULT_GROUP
# 服务openapi接口路径,此处是swagger3版本
knife4j.nacos[0].routes[0].location=/v3/api-docs?group=default

#配置第二个微服务的文档
knife4j.nacos[0].routes[1].name=日志服务
knife4j.nacos[0].routes[1].serviceName=EzLcp-Log
knife4j.nacos[0].routes[1].groupName=DEFAULT_GROUP
knife4j.nacos[0].routes[1].location=/v3/api-docs?group=default
#配置第N个微服务的文档...

将上面的文件复制到宿主机ROOT目录下,不用重启容器,直接刷新浏览器的地址就可以看到聚合后的文档了。如下图:

感觉比在Spring Cloud Gateway中配置聚合还简单些,也不用担心生产环境发布后会暴露接口文档。

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

推荐阅读更多精彩内容