Swagger 사용하는 방법

Intro. Restdocs를 떠나다

🐥 카카오 테크 캠퍼스 - 2단계 6주차 마지막 과제는 API 문서를 작성하는 것이다.
Restdocs로 예시를 들어주셔서 일단 구현은 했는데, Swagger의 UI와 테스트를 할 수 있다는 점이 맘에 들었기 때문이다

그래서 둘 다 만들어 제출하기로 했다! 재밌잖아!

Contents

1. 기본 구성

Swagger 의존성을 먼저 설정합니다

implementation 'io.springfox:springfox-boot-starter:3.0.0'

다음은 application.yml 설정합니다.
application.yml에 아래 코드를 빼먹으면 bean을 받지 못해서 프로젝트가 터집니다…

• ChatGPT로 에러 해결 - Failed to start bean ‘documentationPluginsBootstrapper’

spring:  
	mvc:  
	pathmatch:  
		matching-strategy: ant_path_matcher

마지막으로 Swagger Configuration class를 만들면 1차 구성 완료!

@Configuration
@EnableSwagger2
public class MySwagger {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build()
                .ignoredParameterTypes(ApiIgnore.class)  // Ignore the APIs annotated with ApiIgnore
                .enableUrlTemplating(true);  // Enable URL templating
    }
}

그리고 프로젝트를 실행하면, 잘 프로젝트가 구성 되었음을 알 수 있습니다

2. 꾸며봅시다

컨트롤러 이름 변경

컨트롤러의 이름을 변경하려면 @Api 애노테이션을 컨트롤러 클래스에 추가하고, tags 속성을 사용하여 원하는 이름을 설정하면 됩니다.

@Api(tags = "사용자 API")  
@RequiredArgsConstructor  
@RestController  
public class UserRestController {

레펀런스

• ChatGPT로 에러 해결 - Failed to start bean ‘documentationPluginsBootstrapper’
• Swagger 멋지게 만드는 블로그

부족한 점이나 잘못 된 점을 알려주시면 시정하겠습니다 :>