스프링부트 / Swagger API 설치하기 방법 / spring boot 3, swagger-ui / SpringBoot3

스프링부트를 사용하여 RESTful API를 만들었다면, 지속적인 관리가 필요하다.
swagger를 사용하면 스프링부트에서 제작한 API를 관리하고, 문서화하며, 테스트를 할 수 있도록 도와준다.
예전에는 API 테스트를 위해 별도의 페이지를 만들기도 하고, 오롯이 테스트를 위한 페이지를 만들어 사용하기도 했다.
지금은 어떨까?
swagger를 사용하면 스프링부트로 만들어진 API를 편하게 테스트하고 관리할 수 있다.

Swagger API 문서, 설계 툴

`swagger`는 대표적인 API 문서관리, 설계 툴이다.
API를 만들고 관리한다면 한번쯤 사용해 봤을 것이다.
과거 우리 개발 선배들은  API를 제작하고 테스트를 위해 별도의 페이지를 만들고, 테스트를 했었다.
본인 또한 마찬가지였다.
지금은 어떨까?
swagger를 설치하면 만들어진 모든 API를 한번에 보고, 관리하고, 테스트를 할 수 있다.
과거 API 테스트를 위해 삽질했던 모든 경험들이 주마등처럼 지나갔다.
구구절절 말이 많았으나, 이제 스프링부트 프로젝트에 Swagger API 툴을 설치해 보자.

스프링부트에 Swagger API 설치하기 과정

스프링부트에 Swagger API를 사용하려면 먼저 라이브러리를 import 해야 한다.
스프링부트에서 라이브러리를 import 하는 방법은 `build.gradle` 파일에 `implementation` 키워드를 사용하는 것이다.
Swagger-ui 라이브러리는 `maven repository` 사이트를 참고하고, 링크는 아래에 연결해 두었다.

• [ MVN REPOSITORY - SpringDoc OpenAPI Starter WebMVC UI ]

아래는 스프링부트에 Swagger 라이브러리를 설치하는 과정을 작성해 보았다.

1. IntelliJ를 실행한다.
2. 스프링부트 프로젝트를 생성한다.
3. Rest API 만들기
1. 요청 Url 기준 POST
1. 목록 조회 /test/get-list
2. 단일 조회 /test/get-info
3. 단일 생성 /test/set-info-ins
4. 단일 수정 /test/set-info-upd
5. 단일 삭제/test/set-info-del
2. 요청 Url 기준 GET
1. 목록 조회 /test/get-list
2. 단일 조회 /test/get-info
3. 단일 생성 /test/set-info-ins
4. 단일 수정 /test/set-info-upd
5. 단일 삭제/test/set-info-del
3. 요청 Method 기준
1. 목록 조회 GET       /test/
2. 단일 조회 GET       /test/{id}
3. 단일 생성 POST     /test
4. 단일 수정 PUT       /test/{id}
5. 단일 수정 PATCH   /test/{id}
6. 단일 삭제 DELETE /test/{id}
4. `build.gradle` 파일을 열기한다.
5. `Swagger` 라이브러리를 추가한다.
1. implementation group: 'org.springdoc', name: 'springdoc-openapi-starter-webmvc-ui', version: '2.6.0'
6. 우측 상단 > `Gradle`버튼 클릭
7. `Reload All Gradle Projects` 버튼을 클릭하여 새로고침( 재설치 )한다.
8. 우측 상단 > `Run ~ `버튼을 클릭해 프로젝트를 실행한다.
9. `웹브라우저`를 열기한다.
10. `http://localhost:8080/swagger-ui/index.html`를 주소창에 입력한다.
11. `Swagger API` 화면을 확인한다.

따라하기

.