线上k8s环境swagger2调用接口失败

Bertha 。 2021-10-19 22:12 576阅读 0赞

最近后端项目集成了swagger2，浏览器正常打开了swagger-ui.html，但是调用接口时却报404错误，仔细一看是接口调用地址和浏览器访问地址并不相同。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21yeWFuZzEyNQ_size_16_color_FFFFFF_t_70][]

分析了下接口调用地址的host，它竟然是k8s环境中的后端应用的service。

由于当前项目通过k8s部署，前端和后端app均以容器的形式运行在pod之中，pod之间通过service指定的host和端口号来进行访问，所以浏览器打开swagger-ui.html后，swagger2实际调用的接口地址的host也变成了service，所以会出现404。

解决这个问题的方案很简单，即为swagger2指定host：

初始化Docket对象时通过host方法指定swagger2的host：

@Value("${swagger.host}")
    private String swaggerHost;
    
    new Docket(DocumentationType.SWAGGER_2).host(swaggerHost)
            .groupName("demo")
            .apiInfo(getApiInfo())
            .select()...

将接口地址配置在application.properties中：

swagger.host=xxx.biz/api

这种方案虽然可行，但是不推荐。

由于当前后端应用部署在k8s环境中，镜像挂载到不同namespace中，不同的namespace就是不同的开发环境，而所有镜像都使用了同一个配置文件，所以这就意味着不同开发环境的swagger2调用了同一个地址，显然不合理。如果要避免这个情况，则每次发版打镜像时都需要修改application.properties中的host，很不方便。

所以当前项目决定将swagger2的host配置到k8s的环境变量里面，由于不同开发环境创建Deployment对象的配置文件不同，所以避免了不同环境共用同一个host的情况。

最终解决方案：

在application.properties中添加：

swagger.host=${SERVER_HOST}

在创建Deployment对象的配置文件aws-k8s-devx.yaml中添加：

- name: SERVER_HOST
      value: xxx.biz/api

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21yeWFuZzEyNQ_size_16_color_FFFFFF_t_70]: /images/20211019/ee49fc2ae1f34401a0f35ff344eb784c.png

发表评论取消回复

表情：

评论列表（有 0 条评论，576人围观）

还没有评论，来说两句吧...

相关阅读

相关 k8s 配置service失败

服务暴露的端口不可用查看容器的状态是否为Running。进入容器，然后对容器进行curl。 curl 127.0.0.0:<需要查询的端口> ...

谁践踏了优雅/ 2024年04月20日 11:32/ 0 赞/ 81 阅读

相关 k8s调用GPU

创建可调用GPU的pod apiVersion: apps/v1 kind: Deployment metadata: name:...

冷不防/ 2024年04月18日 10:55/ 0 赞/ 78 阅读

相关轻量级 K8S 环境、本地 K8S 环境Minikube，一键使用（史上最全）

文章很长，而且持续更新，建议收藏起来，慢慢读！[疯狂创客圈总目录博客园版][Link 1] 为您奉上珍贵的学习资源：免费赠送 :[《尼恩Java面试宝典》][Java]

太过爱你忘了你带给我的痛/ 2024年03月27日 10:38/ 0 赞/ 99 阅读

相关 k8s测试环境部署round2

1集群部署，采用kubaadm 2elasticsearch部署 [https://github.com/13567436138/kubernetes-yamls/tree

一时失言乱红尘/ 2023年06月08日 04:42/ 0 赞/ 7 阅读

相关 k8s (2)k8s资源清单的编写

文章目录什么是资源？什么是资源清单？资源清单的格式通过清单部署nginx

ゝ一世哀愁。/ 2022年12月28日 01:41/ 0 赞/ 254 阅读

相关 k8s export openapi/swagger

/swaggerapi Before Kubernetes 1.10, serves Swagger 1.2 /openapi/v2 Kubernetes 1.10

古城微笑少年丶/ 2022年10月26日 12:50/ 0 赞/ 123 阅读

相关 [K8S] 环境变量获取

环境变量(env)是容器级别的参数，为容器设置环境变量方法有 \- 变量值从Pod属性获取 \- 变量值从自定义变量获取 \- 变量值从ConfigMap获取

阳光穿透心脏的1/2处/ 2022年09月09日 04:59/ 0 赞/ 444 阅读

相关【kubernetes/k8s API】k8s client go 接口

1 k8s client 创建 k8s client 客户端建立连接，主要是kube config 配置，默认在工作目录～/.kube文件下，包括k8s apiser

桃扇骨/ 2022年05月22日 04:20/ 0 赞/ 251 阅读

相关 K8s环境搭建

K8s环境搭建实验环境：三台centos7.5 172.26.0.10 master 172.26.0.12 node1

淡淡的烟草味﹌/ 2022年01月16日 12:21/ 0 赞/ 441 阅读

相关线上k8s环境swagger2调用接口失败

最近后端项目集成了swagger2，浏览器正常打开了swagger-ui.html，但是调用接口时却报404错误，仔细一看是接口调用地址和浏览器访问地址并不相同。 ![wat

Bertha 。/ 2021年10月19日 22:12/ 0 赞/ 577 阅读