在Linux環境中,Swagger與Docker可以協同工作,以簡化API文檔的生成和部署過程。以下是它們協同工作的基本步驟:
# 使用官方的OpenJDK鏡像作為基礎鏡像
FROM openjdk:11-jre-slim
# 設置工作目錄
WORKDIR /app
# 將構建好的JAR文件復制到鏡像中
COPY target/your-application.jar /app/your-application.jar
# 暴露應用程序的端口
EXPOSE 8080
# 容器啟動時運行的命令
CMD ["java", "-jar", "your-application.jar"]
docker build -t your-application-image .
docker run -p 8080:8080 your-application-image
訪問Swagger UI:一旦容器運行起來,你可以通過訪問http://localhost:8080/swagger-ui/
來查看和與Swagger UI交互。
使用Docker Compose(可選):如果你的應用程序由多個服務組成,可以使用Docker Compose來簡化管理和部署。創建一個docker-compose.yml
文件,定義服務和它們的網絡配置:
version: '3'
services:
swagger-ui:
image: your-application-image
ports:
- "8080:8080"
然后運行docker-compose up
來啟動所有服務。
通過這種方式,Swagger UI和應用程序被打包在一個Docker容器中,確保了環境的一致性,并且可以輕松地復制和部署到任何支持Docker的環境中。