OpenAPI Specification을 이용한 더욱 효과적인 API 문서화 | 카카오페이 기술 블로그

구현

구현 순서는 다음과 같습니다.

  1. Swagger-UI standalone, Static Routing 세팅
  2. restdocs-api-spec을 이용한 OAS 파일을 생성하는 빌드 환경 구축
  3. SampleController 코드 작성
  4. MockMvc REST Docs Test 코드 작성

Swagger-UI standalone, Static Routing 세팅

https://github.com/swagger-api/swagger-ui/releases/tag/v5.11.3

Untitled

Untitled

// Resource Handler 설정
@Configuration
public class StaticRoutingConfig implements WebMvcConfigurer {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/static/dist/**")
            .addResourceLocations("classpath:/static/dist/");

        registry.addResourceHandler("swagger-ui.html")
            .addResourceLocations("classpath:/static/dist/swagger-ui/");
    }
}