526互联

如何通过swagger ui生成k8s api的文档？

发布时间 2023-09-06 11:02:36作者: Zhai_David

当涉及到k8s开发的时候，需要用到k8s 的api。

 

如果要获得k8s api的使用文档，该如何来做？

 

1、生成k8s的api列表

kubectl get --raw /openapi/v2  > k8s-openapi-v2.json

 

 

这个json文件就包含了k8s的api列表

 

2、使用swagger ui工具解析api 列表

 

在步骤1生成的json文件的目录中执行下面的命令

docker run \
  -d \
  --name k8s-api-swagger-ui \
  -v $PWD/k8s-openapi-v2.json:/app/swagger.json \
  -p 8028:8080 \
  172.20.58.152/tools/swaggerapi/swagger-ui:latest

 

注意：需要在环境有中swagger-ui的镜像

 

可以通过下面的命令下载，上传到本地的镜像仓库中：

docker pull swaggerapi/swagger-ui

 

 

3、浏览器访问swagger ui

访问地址：http://<容器所在主机的IP>:8028

 

例如：

http://172.11.18.83:8028

 

这样，就可以看到api及对应的文档信息了

 

 

包括参数，实例，具体的使用的规范。