可视化k8s API文档

介绍

调用k8s API时，查找接口具体使用方式不是很方便。这时可以使用Swagger UI来实现可视化k8s API文档。

Swagger UI允许任何人可视化API的资源并与之交互，而无需任何实现逻辑。它是由OpenAPI(以前称为Swagger)规范自动生成的，可视化文档使后端实现和客户端使用变得容易。

安装

官方文档：https://swagger.io/docs/open-source-tools/swagger-ui/usage/installation/

生成api文档

curl -k https://localhost:6443/openapi/v2 > k8s-swagger.json

启动swagger-ui容器

docker pull swaggerapi/swagger-ui
docker run -d -p 33080:80 -e SWAGGER_JSON=/k8s-swagger.json -v /root/k8s-swagger.json:/k8s-swagger.json swaggerapi/swagger-ui
docker ps

使用

浏览器访问ip:33080，ecs安全组需要放开33080端口。

查看请求参数

查看返回

可以点击try it out修改请求体的参数测试