Swagger2

• 

  Spring Rest Docs 트러블 슈팅 스프링 진영에서는 API 명세서로 사용하는 대표적인 두 가지가 있다. 바로 Swagger와 Spring Rest Docs다. 간단하게 설명하면 Swagger는 도입이 매우 편리하지만 운영 코드가 지저분해지고 기능적인 보장을 할 수 없다. Spring Rest Docs는 테스트를 기반으로 작성되므로 운영 코드가 지저분해지지 않고 기능적인 보장을 한다. 다만 적용하는데 꽤 많은 시간이 소요된다. 저번 동아리 프로젝트는 빠르게 개발을 해야하므로 Swagger을 도입했었다. 이번에는 졸업 프로젝트를 하면서 새로운 기술을 도입해보고 싶었기에 Spring Rest Docs를 도입하기로 결정했다. 이번 포스팅에서는 구체적인 도입 방법보다는 트러블 슈팅과 해결 과정을 기록하려고 한다. Spring Rest Docs를 .. 기록 및 회고 2022. 9. 1.

• 

  Spring Interceptor 경로에서 Swagger 경로 제거 시 발생 오류 UMC 동아리에서 앱을 만드는 팀 프로젝트를 진행 중인데 한 가지 오류가 발생했다. 바로 JWT를 사용해서 로그인을 진행할 때 스프링 인터셉터를 사용 중인데 스웨거 경로를 exclude하자 오류가 발생했다. 파파고로 내용을 해석하면 아래와 같았다. "기본 URL을 유추할 수 없습니다. 이는 동적 서블릿 등록을 사용하거나 API가 API 게이트웨이 뒤에 있을 때 흔히 발생합니다. 기본 URL은 모든 스웨거 리소스가 제공되는 루트입니다. 예를 들어 http://example.org/api/v2/api-docs에서 api를 사용할 수 있는 경우 기본 URL은 http://example.org/api/입니다. 위치를 수동으로 입력하십시오." 처음 파파고를 돌려보고 '뭔 소리지..?'라는 생각이 들었다. 기존에 .. 개발/Spring MVC 2022. 7. 8.