[해커톤]Swagger_이용방법(spring boot)

 

 

1. build.gradle에 의존성에

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

를 추가해준다. 

 

 

2. 그 때 뜨는 코끼리 모양을 눌러 의존성을 추가해준다. 

 

 

3. config에 SwaggerConfig를 만든다.

 

4. 코드를 입력한다. 

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;

@Configuration
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.OAS_30) // open api spec 3.0
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

}

 

 

 

5. 서버를 띄운다. 

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

 

 

 

6. swagger 사이트를 들어가면 API들이 보인다. 

 

 

 

 

7. API를 확인한다. 

 

 

 

8.  직접 실행 시킬 수 있다. 

 

 

DB와도 연결되어있기에 값들을 확인할수도, 변경할 수도 있다. 

 

 

 

즉 구글 스프레드시트와 postman의 역할을 합한것이다. 

 

 

 

 

 

참고 자료 : 

https://blog2.deliwind.com/20201127/java-swagger-ui-3-0-%EC%82%AC%EC%9A%A9%ED%95%98%EA%B8%B0/

java-swagger-ui-3.0-사용하기