在linux容器化环境中部署swagger(现已更名为openapi), 只需几个简单的步骤:
-
准备OpenAPI规范文档: 首先,您需要一个符合OpenAPI规范的API文档 (YAML或json格式),详细描述您的API接口,包括路径、参数、请求和响应等信息。
-
构建docker镜像: 使用Dockerfile,基于swaggerapi/swagger-ui基础镜像,将您的OpenAPI规范文档复制到镜像中的指定位置。 然后,运行docker build命令构建镜像。
-
运行Docker容器: 使用docker run命令运行构建好的镜像,并使用-p参数映射容器端口到主机端口。例如:docker run -p 8080:80 my-swagger 将容器的80端口映射到主机的8080端口。
-
访问Swagger UI: 在浏览器中访问映射的主机端口 (例如:http://localhost:8080),即可查看和测试您的API文档。
对于更复杂的场景,推荐使用Docker Compose简化部署和管理。 创建一个docker-compose.yml文件,定义并运行多个容器,例如Swagger Editor和Swagger UI:
version: '3' services: swagger-editor: image: swaggerapi/swagger-editor:latest ports: - "8080:8080" swagger-ui: image: swaggerapi/swagger-ui:latest ports: - "8081:8080"
运行docker-compose up启动服务。
通过Docker容器化,Swagger的部署变得更加灵活、可移植,并方便团队协作和文档管理。