swagger 2

📚 개발과 소통, Swagger 하나로 끝냅니다

안녕하세요 makeviibe 입니다.​✅ 왜 API 문서화가 중요할까?서비스 개발에서 프론트엔드와 백엔드는 API를 기준으로 연결됩니다.또, 외부와 연동하는 서비스라면 제3자 개발자도 API를 이해해야 하죠.그런데…“이 API가 어떤 데이터 받을 수 있지?”“응답 형식이 바뀐 거 같은데?”“예전에는 잘 됐는데 지금은 왜 오류지?”이런 말이 오갈 때마다 실시간 문서를 찾아보기 어렵다면협업은 혼란, 유지보수는 고통으로 바뀝니다.그래서 makeviibe 팀은 Swagger를 이용한 API 문서화를 모든 프로젝트에 적용하고 있습니다.🛠️ Swagger가 뭐예요?Swagger는 백엔드에서 만든 API를 자동으로 문서화해주는 도구입니다.정확히는 OpenAPI 스펙을 기반으로, API 명세를 웹페이지 형태로 자동 ..

Swagger가 기본 페이지로 열릴 때? 프록시 설정으로 바로잡기

안녕하세요 makeviibe 입니다.최근 EC2 환경에서 프론트엔드(React)와 백엔드(Spring Boot + Kotlin)를 하나의 서버에 배포했습니다.Nginx를 통해 모든 요청을 받아 프론트/백엔드로 라우팅하는 구조였는데,배포 후 Swagger 페이지에 접속했을 때 예상과 다른 화면이 열렸습니다.🐛 문제 상황Swagger는 백엔드에서 /v3/api-docs/ 또는 /swagger-ui.html 경로를 통해 접근합니다.하지만 실제 브라우저에서 해당 주소로 접속했을 때,Swagger UI가 아닌, 프론트엔드(React)의 기본 페이지(index.html) 가 열렸습니다.즉, Swagger 요청이 백엔드가 아닌 프론트엔드 정적 파일로 전달된 것이었습니다.🔍 원인Nginx 설정에서 모든 경로를 Re..

개발일지 2025.07.15