Swagger 2

Spring Security 필터로 인한 Swagger-ui.html 접속 불가

TroubleShooting 발생한 문제 스웨거 세팅을 했으나 Spring Security 필터로 인하여 스웨거 화면이 뜨지 않는 현상 발견. 해결 및 시도 방법 1. 먼저, h2-console을 확인할 때도 비슷한 경험이 있었기에 HTTP frame option 관련인지 확인. 하지만, h2-console 때문에 이미 설정했으므로 문제 없다고 판단. 2. 다른 리소스들이 들어오지 않아 그림을 못그리는 것인지 확인하기 위해 개발자 콘솔을 확인. localhost:8080/webjars 관련이 못들어오는 것을 확인. 스웨거 리소스가 webjars에만 있을 것 같지 않아 스웨거 리소스에 대한 정보를 얻기 위해 구글링 시작함. 관련 키워드로 구글링 -> `swagger security filter` 스택 오버..

Troubleshooting 2022.08.20

Springfox-Swagger2 사용해보기

Swagger Swagger란 REST APU의 문서화를 위해 사용하는 것. 단순히 postman처럼 테스팅하는 용도로 사용되는 줄 알았으나 라이브러리로서 개발자가 REST API 문서 작성을 쉽고 간단하게 자동화하도록 도와준다. 간단한 설정만으로도 API 목록을 웹에서 확인 가능하고 테스트까지 가능하게 해주는 라이브러리다. 작은 과제 프로젝트를 위해 직접 작성했었는데 이번에는 Swagger를 공부하고 도입하여 과제 프로젝트 REST API 문서를 작성해보려고 한다. REST API 문서화는 왜 필요한가? 프로젝트의 개발과 유지보수 과정에서 API의 규격을 정의한 문서는 반드시 필요하다. 만약 API 문서가 없다면 API를 확인할 때 시간 낭비가 생기고 소통의 문제가 생길 것이며 테스트를 진행할 때도 코..

Web Dev 2022.07.29