[Spring boot] Swagger API 연동하기

Swagger 설정하는 방법

• Swagger 설정하기 위한 라이브러리는 2가지가 있다
• Spring - Fox , Spring - Dox 2가지 중에 사용하면 된다.

Spring - Fox

• 오래전에 나온 라이브러리이다. (2015년)
• 2020년 이후로 업데이트가 멈췄다.
• 따라서 Spring Boot 2.6 이상 버전에서는 바로 적용이 안된다. 
• https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui

Spring - Doc

• 최근에 나온 라이브러리 이다. (2019년)
• 업데이트가 최근까지도 이루어지고 있다.
• Spring Boot 2.6 이상도 지원한다.
• https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-ui

---

Gradle 설정하기

// https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-ui
implementation group: 'org.springdoc', name: 'springdoc-openapi-ui', version: '1.7.0'

• 제일 최근 버전이다. 위에 적어둔 홈페이지로 이동하여 원하는 버전으로 가져오면 된다.

Config 파일 만들기

@Configuration
public class DocsConfiguration {

    @Bean
    GroupedOpenApi testRegApi() {
        return GroupedOpenApi.builder()
                .pathsToMatch("/api/**")
                .displayName("definition")
                .group("Test")
                .build();
    }
}

Controller 설정

@RestController
@RequestMapping("api/test")
public class TestRegController {
    @Operation(summary = "get posts", description = "지역에 대한 posts들 가져오기")
    @ApiResponses({
            @ApiResponse(responseCode = "200", description = "OK"),
            @ApiResponse(responseCode = "400", description = "BAD REQUEST"),
            @ApiResponse(responseCode = "404", description = "NOT FOUND"),
            @ApiResponse(responseCode = "500", description = "INTERNAL SERVER ERROR")
    })

 

 

참고문헌

[Spring boot] Swagger API 연동하기