
本文介紹如何在Linux服務器上部署Swagger,重點講解使用docker容器化部署,這是一種便捷且靈活的方案,支持遠程訪問。
Docker容器化部署Swagger Editor和Swagger ui
-
安裝Docker: 首先,確保你的Linux服務器已安裝Docker。 參考Docker官方文檔Docker安裝指南進行安裝。
-
部署Swagger Editor:
- 拉取鏡像: docker pull swaggerapi/swagger-editor:v4.6.0
- 運行容器,將容器的8080端口映射到宿主機的8088端口:docker run -d -p 8088:8080 swaggerapi/swagger-editor:v4.6.0
- 通過瀏覽器訪問http://你的服務器IP:8088訪問Swagger Editor。
-
部署Swagger UI:
- 拉取鏡像: docker pull swaggerapi/swagger-ui:v4.15.5
- 運行容器,將容器的8080端口映射到宿主機的8080端口:docker run -d -p 8080:8080 swaggerapi/swagger-ui:v4.15.5
- 通過瀏覽器訪問http://你的服務器IP:8080訪問Swagger UI。
使用Cpolar實現(xiàn)遠程訪問
為了遠程訪問部署好的Swagger,可以使用Cpolar工具將本地端口映射到公網(wǎng)。
-
安裝Cpolar: 訪問Cpolar官網(wǎng)獲取安裝命令并安裝Cpolar。
-
創(chuàng)建Cpolar隧道: 在Cpolar中,創(chuàng)建隧道將Swagger Editor和Swagger UI的端口映射到公網(wǎng)。 你將獲得一個公網(wǎng)地址,用于遠程訪問。
-
固定公網(wǎng)地址 (可選): 為了獲得穩(wěn)定的公網(wǎng)地址,建議在Cpolar中配置二級子域名,避免地址隨機變化。 參考ain/”>Cpolar固定公網(wǎng)地址教程。
使用apache或Nginx作為Web服務器 (傳統(tǒng)方法)
如果你更傾向于使用傳統(tǒng)Web服務器,Apache或Nginx也是不錯的選擇。
-
配置Apache:
- 安裝Apache并啟用默認站點: sudo a2ensite default.conf && sudo systemctl restart apache2
- 修改/etc/apache2/sites-available/default文件,將DocumentRoot指向Swagger UI和Swagger Editor的文件位置。
-
配置nginx:
- 安裝Nginx并創(chuàng)建配置文件 (例如,備份默認配置文件并創(chuàng)建一個新的): sudo cp /etc/nginx/sites-available/default /etc/nginx/sites-available/default.backup && sudo nano /etc/nginx/sites-available/my-swagger
- 在配置文件中,修改server塊的root和index指令,指向Swagger UI和Swagger Editor。
- 重啟Nginx: sudo systemctl restart nginx
選擇以上任一方法,即可在Linux服務器上成功部署Swagger并實現(xiàn)本地或遠程訪問。 根據(jù)實際需求選擇最合適的方式。