在linux容器化環(huán)境中部署swagger(現(xiàn)已更名為openapi), 只需幾個(gè)簡(jiǎn)單的步驟:
-
準(zhǔn)備OpenAPI規(guī)范文檔: 首先,您需要一個(gè)符合OpenAPI規(guī)范的API文檔 (YAML或json格式),詳細(xì)描述您的API接口,包括路徑、參數(shù)、請(qǐng)求和響應(yīng)等信息。
-
構(gòu)建docker鏡像: 使用Dockerfile,基于swaggerapi/swagger-ui基礎(chǔ)鏡像,將您的OpenAPI規(guī)范文檔復(fù)制到鏡像中的指定位置。 然后,運(yùn)行docker build命令構(gòu)建鏡像。
-
運(yùn)行Docker容器: 使用docker run命令運(yùn)行構(gòu)建好的鏡像,并使用-p參數(shù)映射容器端口到主機(jī)端口。例如:docker run -p 8080:80 my-swagger 將容器的80端口映射到主機(jī)的8080端口。
-
訪問Swagger UI: 在瀏覽器中訪問映射的主機(jī)端口 (例如:http://localhost:8080),即可查看和測(cè)試您的API文檔。
對(duì)于更復(fù)雜的場(chǎng)景,推薦使用Docker Compose簡(jiǎn)化部署和管理。 創(chuàng)建一個(gè)docker-compose.yml文件,定義并運(yùn)行多個(gè)容器,例如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"
運(yùn)行docker-compose up啟動(dòng)服務(wù)。
通過Docker容器化,Swagger的部署變得更加靈活、可移植,并方便團(tuán)隊(duì)協(xié)作和文檔管理。