Swagger 적용을 위해서는 2가지의 Spring Framework가 존재한다.
이번 프로젝트에서는 처음에 SpringFox로 Swagger 적용을 하려 하였으나 localhost:4000/Swagger-ui/index.html 서버를 찾지 못하는 현상이 반복적으로 일어났다.
그래서 SpringDoc으로 변경하여 Swagger 적용을 진행하였다. 여기서 또한 SpringFox 때와 같은 Trouble이 발생하였는데 이에 대한 원인으로 현재 사용하고 있는 Spring boot의 버전과 관련되었다.
SpringDoc을 주입하기 위해 사용된 implemetation은
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:1.9.6'
→ 이는 springBoot 2.~~ 에 적용이 가능한 springDoc이였다. 하지만, 현재 프로젝트에서는 springBoot 3.0.6 환경에 있었으므로 버전을
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2'
으로 변경하여 주입하여야 했다.
Swagger를 통해 Controller의 정보를 가져오기 위해서는 각 Controller Class 마다 @Tag 어노테이션을 붙여서 가져올 수 있다는 메뉴얼이 있다.
하지만, SpringBoot에 있는 자동 스캐닝 기능으로 어노테이션을 명시적으로 나타낼 필요없이 모든 컨트롤러의 정보를 가져올 수 있다.
Spring Boot는 기본적으로 @RestController 어노테이션이 선언된 클래스를 컨트롤러로 인식
→ Spring Boot는 자동으로 API 엔드포인트를 생성하여 해당 엔드포인트에 대한 정보를 Swagger UI에 표시
jasypt.password 가 코드 내부에 존재하면 암호화한 의미가 없기 때문에 외부에서 전달 받아 사용할 수 있도록 했다.@Value("${jasypt.password}")
private String encryptKey;

@SpringBootApplication
@EnableJpaAuditing
@EnableEncryptableProperties
public class WithInApplication {
...
}
@EnableEncryptableProperties는 jasypt라이브러리를 활성화하고, 암호화된 값을 복호화하는 빈을 생성한다. 따라서, jasypt로 암호화한 정보들을 쉽게 관리할 수 있다.