Skip to content

chore: nginx에 Swagger UI/OpenAPI 문서 프록시 경로 추가 - #245

Merged
sjungwon03 merged 1 commit into
devfrom
chore/244-nginx-swagger-proxy
Jul 24, 2026
Merged

chore: nginx에 Swagger UI/OpenAPI 문서 프록시 경로 추가#245
sjungwon03 merged 1 commit into
devfrom
chore/244-nginx-swagger-proxy

Conversation

@sjungwon03

Copy link
Copy Markdown
Member

변경 내용

  • nginx.conf/swagger-ui/, /swagger-ui.html(정확히 일치), /v3/api-docs(정확히 일치)를 backend:8080으로 프록시하는 location 3개 추가
  • 기존 /api/ 프록시, SPA fallback(location /)은 그대로 유지

배경

백엔드에 springdoc-openapi 기반 Swagger 문서를 도입했지만(back-end#213, back-end#215), 기존 nginx.conf/api/만 프록시하고 있어 배포 도메인에서 Swagger 경로 요청이 backend로 가지 않고 SPA fallback(index.html)으로 떨어져 열리지 않았다.

검증

  • docker compose config 통과
  • docker compose up -d --build backend frontend 로 로컬 재현 후 frontend 컨테이너 내부에서 직접 확인 (호스트 5173 포트는 로컬 vite dev 서버가 이미 점유하고 있어 컨테이너 내부 127.0.0.1:80으로 직접 검증)
    • GET /v3/api-docs → 200
    • GET /swagger-ui/index.html → 200, 본문이 실제 swagger-ui 정적 번들(SPA index.html이 아님) 확인
    • GET / → 200, 기존 SPA 라우팅 정상 유지 확인
    • nginx -t 문법 검증 통과

연결 이슈

Closes #244

/api 프리픽스 밖에 있는 백엔드 springdoc 경로(/swagger-ui/**,
/swagger-ui.html, /v3/api-docs)가 SPA fallback(index.html)으로
떨어져 배포 도메인에서 열리지 않던 문제를 backend로 직접 프록시하여
해결한다.

Closes #244
@sjungwon03 sjungwon03 added the chore 빌드, 배포, 기타 등등 label Jul 24, 2026
@sjungwon03 sjungwon03 self-assigned this Jul 24, 2026
@sjungwon03
sjungwon03 merged commit b88d759 into dev Jul 24, 2026
2 checks passed
@sjungwon03
sjungwon03 deleted the chore/244-nginx-swagger-proxy branch July 24, 2026 07:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore 빌드, 배포, 기타 등등

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore: nginx에 Swagger UI/OpenAPI 문서 프록시 경로 추가

1 participant