[Spring] Swagger & CORS

박세윤·2023년 4월 25일
0

Spring

목록 보기
10/11
post-thumbnail

📖 Swagger & CORS

📌 Swagger


✅ Swagger를 이용한 REST API 문서화

  • 프로젝트 개발 시 일반적으로 FrontEnd 개발자와 BackEnd 개발자 분리

  • FrontEnd 개발자의 경우 화면에 집중하고 BackEnd 개발자가 만든 문서 API를 보며 데이터 처리

  • 개발 상황의 변화에 따른 API 추가 또는 변경 때마다 문서에 적용하는 불편함 발생

  • 이러한 문제를 해결하기 위해 Swagger 사용



✅ Swagger?

  • 기존 문서로 사용하던 문제를 해결하기 위해 Swagger 사용

  • 간단한 설정으로 프로젝트의 API 목록을 웹에서 확인 및 테스트 할 수 있게 해주는 라이브러리

  • Swagger를 사용하면 Controller에 정의되어 있는 모든 URL 바로 확인 가능

  • API 목록 뿐 아니라 API의 명세 및 설명도 볼 수 있으며, 또한 API를 직접 테스트 해 볼 수도 있다.



✅ Swagger 적용

  • pom.xml에 swagger2 dependency 추가



✅ Swagger 설정



✅ Swagger 관련 Annotation



📌 CORS


✅ CORS

  • CORS : 교차 출처 리소스 공유



✅ CORS 해결하기

  • 프록시 서버 활용

  • 헤더 추가

  • @CrossOrigin 활용

profile
개발 공부!

0개의 댓글