RSS DEV 커뮤니티

Swagger UI + Docker: 초기 설정

환경은 Apple M1 CPU가 장착된 Mac에서 Sonoma 14.6.1 OS를 실행하고 Docker Desktop 버전 4.34.2를 사용합니다. 디렉터리 구조에는 세 개의 하위 디렉터리(top, docker, openapi)가 있습니다. docker 하위 디렉터리에는 .env 파일과 docker-compose.yml 파일이 포함되어 있으며, openapi 하위 디렉터리에는 openapi.yml 파일이 포함되어 있습니다. .env 파일에서는 SWAGGER_UI_HOST_PORT 변수를 설정합니다. docker-compose.yml 파일에서는 swagger-ui라는 서비스를 정의하는데, 공식적인 swaggerapi/swagger-ui:v5.17.14 이미지를 사용합니다. 환경 변수 SWAGGER_JSON은 openapi.yml 파일의 절대 경로로 설정되며, Docker 컨테이너 내부에 볼륨으로 마운트됩니다. 컨테이너에서는 8080 포트를 노출시키고, openapi.yml 파일에서는 OAS 3.0.3에 따라 최소한의 API 문서를 정의합니다. 컨테이너와 이미지를 생성하려면 터미널에서 docker compose create를 실행한 후 docker compose start로 컨테이너를 시작해야 합니다. 마지막으로 사용자는 브라우저에서 http://localhost:{SWAGGER_UI_HOST_PORT}를 열어 Swagger UI에 액세스할 수 있습니다.
favicon
dev.to
Swagger UI + Docker: Initial Setup