在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的部署變得更加靈活、可移植,并方便團隊協作和文檔管理。