[SpringBoot] API 문서 자동화 Tool인 Swagger 만들어보기

1016

1. 의존성 추가

build.gradle에 아래의 코드를 추가합니다.
이는 springdoc 라이브러리를 사용하여 swagger를 만들어보겠다는 뜻입니다.

dependencies {
	...
	implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0'
}

2. Swagger 사용을 위한 Config 만들기

config 패키지를 하나 만들고 그 안에 WebConfig라는 자바 파일을 하나 만들겠습니다.

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                .allowedOriginPatterns("*")
                .allowedMethods("GET", "POST", "PUT", "DELETE")
                .allowedHeaders("Authorization", "Content-Type")
                .exposedHeaders("Custom-Header")
                .allowCredentials(true)
                .maxAge(3600);
    }
}

여기서 주의할 점이 있는데 .allowedOrigins("*")이 .allowCredentials(true)와 함께 쓰이지 못하도록 업데이트가 되었기 때문에 .allowedOrigins("*")을 .allowedOriginPatterns("*")로 바꿔주어야 합니다.

3. Swagger 접속하기

이제 준비가 완료되었습니다.
http://localhost:8080/swagger-ui/index.html#/
로 이동하면 내가 만든 api를 한 눈에 볼 수 있습니다.