[Spring Boot] swagger @ApiResponse response에 List 타입의 결과 예시 보여주는 방법

Chae Eun Kim·2023년 3월 16일
0

spring boot

목록 보기
1/5
  • response 종류 1개일 경우

List<MemberUserResponseDto> 타입의 결과값을 스웨거에 예시로 띄워주고 싶을 때 아래와 같이 responseContainer를 사용하면 된다.

@ApiResponse(code = 200, message = "일반 회원 리스트 조회 성공", response = MemberUserResponseDto.class, responseContainer = "List")



  • response 종류 여러개일 경우

아래와 같이 작성하면됨

@ApiResponses({
            @io.swagger.annotations.ApiResponse(code = 200, message = "일반 회원 리스트 조회 성공", response = MemberUserResponseDto.class, responseContainer = "List"),
            @io.swagger.annotations.ApiResponse(code = 400, message = "삭제할 수 없습니다."),
    })

0개의 댓글