TIL - 23.12.28

내일이 과제 제출일이라 어제 오늘 과제에 집중했다.

 

과제는 ToDoList API를 작성하는 것이였다.

 

API작성은 swagger를 통해 작성한 API명세를 확인할 수 있는데, http://localhost:8080/swagger-ui/index.html 이 url을 접속하면 확인할 수 있다.

접속한 후 화면을 보면 API들이 나와있는데 이 API들은 어떤 기능을 하는지 명시적으로 나와있지 않다. 

 

구글링을 해보니 @ApiOperator라는 swagger 어노테이션이 존재하는데 이걸 사용하여 swagger ui에 설명을 추가할 수 있었다. 

 

그런데 이 어노테이션을 임포트 하지 못하는 문제가 있었다.

 

찾아보니 의존성을 추가하는 부분에서 내가 추가한 implementation과 구글링을 통해 찾은 implementation이 다른 것을 확인했다.

implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0")

강의에서 알려준 swagger implementation이다. 

 

implementation("io.springfox:springfox-swagger-ui:3.0.0")
implementation("io.springfox:springfox-boot-starter:3.0.0")

이 코드가 구글링을 해서찾은 implementation이다.

 

그러나 gradle을 재설정해주고 swagger ui를 확인했지만 Whitelabel Error Page가 떴다.

 

찾아보니 구글링 해서 찾은 implementation은 스프링부트 2.x.x 버젼일 경우에 사용하는 코드고

 

현재 내가 사용중인 스프링부트는 3.1.7 버젼이였다.

 

이 버젼차이 때문에 작동을 하지 않은 것이다.

 

나머지 내용은 Controller 계층을 작성하고 Service 계층과 연결해주는 내용이라 강의를 참고해가며 코드를 작성했다.