[이커머스 프로젝트] Swagger2 적용

|  Swagger2 적용하기

 

[1] 의존성 주입

implementation group: 'io.springfox', name: 'springfox-swagger2', version: '2.9.2'
implementation group: 'io.springfox', name: 'springfox-swagger-ui', version: '2.9.2'

 

[2] Swagger2 UI 환경 파일 추가

package com.zerobase.cms.user.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket swagger(){
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

}

 

[3] Controller 를 작성한다.

- Controller 작성시 @ApiOperation 어노테이션을 사용해 API 주석을 단다.

@RestController
@RequiredArgsConstructor
public class TestController {

    private final EmailSendService emailSendService;

    @GetMapping
    @ApiOperation(value = "이메일 전송 테스트 API", notes="이메일 전송 테스트")
    public Response sendTestEmail(){
        return emailSendService.sendEmail();
    }

}

 

[4] 마지막으로 application을 실행한 후,  브라우저에서 확인

http://localhost:8080/swagger-ui.html

 

 

[ 출처 ]

https://sharplee7.tistory.com/48

https://kim-jong-hyun.tistory.com/49