Spring Boot와 Swagger를 활용한 API 개발

Spring Boot와 Swagge를 활용한 API 개발 과정에 대해 다루겠습니다. 프로젝트 생성부터 Swagger 적용까지 차근차근 알아봅니다.

프로젝트 생성

1. Spring Initializr로 프로젝트 생성

Dependencies는 Spring Web, Spring Boot DevTools 등 필요한 의존성들을 담으세요. 나중에 추가하거나 제거할 수 있으니 대략적으로 생각하셔도 괜찮습니다.

기본 설정을 마치고 GENERATE

2. Swagger 의존성 추가

프로젝트를 열고 build.gradle에 아래 dependency를 추가합니다.

dependencies {

    // Swagger 의존성
    implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2")
}

Maven의 경우

<dependencies>
   
    <!-- SpringDoc OpenAPI UI dependency-->
    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
        <version>2.0.2</version>
    </dependency>

    <!-- SpringDoc OpenAPI Core dependency-->
    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-core</artifactId>
        <version>2.0.2</version>
    </dependency>
</dependencies>

변경 후 우측 상단의 코끼리 모양을 눌러서 Gradle 변경 사항을 Load하세요.

Swagger 로컬 테스트

프로젝트 빌드 후 아래 주소로 들어가세요. 아래 화면이 뜨면 성공입니다.
빌드가 안 된다면, 아래 첨부된 글들을 확인해보세요 🙂

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

빌드 관련 에러

[Spring Error] Web server failed to start. Port 8080 was already in use.
[Spring Error] Error starting ApplicationContext. To display the condition evaluation report re-run your application with ‘debug’ enabled.