[SpringBoot] 스프링 부트 3.2.3에서 Swagger(springdoc) 사용하기!

📌환경

IntelliJ Ultimate

Java 17

 

Spring boot 3.2.3

Gradle - Groovy

Dependencies: 

Spring Web

Thymeleaf

Spring Data JPA

lombok

MariaDB 10.11

Spring Dev tool

 

 

이전 글에서 springfox 대신 springdoc을 사용하는 방법을 알아보았다. springfox와 springdoc는 사용 방법이 조금 다르기 때문에 차근차근 따라가던 책이나 강의에서 springfox를 사용한다면 진행이 어려울 수 있다. 나 역시 그 문제를 겪었기 때문에 해당 글을 작성한다.

 

내가 참고한 책(자바 웹 개발 워크북)에서는 REST 방식으로 댓글을 처리하기 위해 `ReplyDTO`를 만들고, JSON으로 swagger를 통해 데이터를 전송한 뒤 `ReplyController`에서 이를 처리하는 방식을 사용한다.

springfox로 작성된 `ReplyController` 코드는 다음과 같다.

 

package org.zerock.b02.controller;

import io.swagger.annotations.ApiOpertaion;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.zerock.b02.dto.ReplyDTO;

import java.util.Map;

@Controller
@RequestMapping("/replies")
@Slf4j
public class replyController {

    @ApiOperation(value = "Replies Post" notes = "POST 방식으로 댓글 등록")
    @PostMapping(value = "/", consumes = MediaType.APPLICATION_JSON_VALUE)
    public ResponseEntity<Map<String, Long>> register(@RequestBody ReplyDTO replyDTO){

        log.info("replyDTO........" + replyDTO);

        Map<String, Long> resultMap = Map.of("rno", 111L);

        return ResponseEntity.ok(resultMap);
    }



}

 

 

`@ApiOperation` 애너테이션이 사용된 것을 확인할 수 있다. springdoc에서는 `@ApiOperation` 대신 `@Operation`을 사용하므로 20번째 줄의 애너테이션만 다음과 같이 수정해준다.

 

@Operation(summary = "reply POST", description = "POST 방식으로 댓글 등록")

 

 

 

 

 

http://localhost:8080/swagger-ui/index.html에 접속해보면 위와 같이 잘 들어온 것을 확인할 수 있다. 

 

`Try it out`을 누르고 excute하면 다음과 같은 로그를 확인할 수 있다.

 

 

2024-03-13T22:59:30.791+09:00  INFO 87464 --- [b02] [nio-8080-exec-4] o.springdoc.api.AbstractOpenApiResource  : Init duration for springdoc-openapi is: 115 ms
2024-03-13T23:12:17.761+09:00  INFO 87464 --- [b02] [nio-8080-exec-6] o.springdoc.api.AbstractOpenApiResource  : Init duration for springdoc-openapi is: 43 ms
2024-03-13T23:18:12.240+09:00  INFO 87464 --- [b02] [nio-8080-exec-2] o.zerock.b02.controller.replyController  : replyDTO........ReplyDTO(rno=0, bno=0, replyText=string, regData=2024-03-13T14:17:56.754, modDate=2024-03-13T14:17:56.754)