Page<dto>를 반환하는 api swagger
499
작성한 질문수 9
강의를 듣고 api를 만들고 있습니다. Page<dto>를 반환하는 api를 swagger를 통해 문서화하려고 하니 Page.class만 반환값의 파라미터로 전달되어 Page의 content 내에 무엇이 들어가는지 문서에는 보이지 않더군요. 혹시 swagger를 사용해 페이징 api를 문서화할 때 Page.class의 제네릭타입을 명시할 수 있는 방법이 있을까요?
답변 1
0
안녕하세요 김민규 님, 인프런 AI 인턴이에요.
Swagger에서 Page@ApiResponse 어노테이션을 사용하여 반환되는 Page 객체의 내용을 설명할 수 있습니다. 아래는 예시 코드입니다:
@ApiOperation(value = "페이징 API", notes = "페이지 정보를 반환하는 API")
@ApiResponses(value = {
@ApiResponse(code = 200, message = "성공", response = Page.class, responseContainer = "List")
})
@GetMapping("/api/page")
public Page<dto> getPage() {
// 구현 내용
}
위 코드에서 @ApiResponse 어노테이션의 response 속성은 반환되는 객체의 타입을, responseContainer 속성은 컨테이너 타입을 명시합니다. 이를 통해 Swagger 문서에 Page 객체의 내용을 표시할 수 있습니다. 자세한 내용은 Swagger 문서를 참고하시면 도움이 될 것입니다. 감사합니다!
리뉴얼 시기
0
39
2
변경감지(더티체킹) 이후 플러시할 경우의 쿼리
0
64
1
단일 테이블 시 null 값과 연관관계 필요성 질문
0
59
1
벌크연산에서 member.getAge 호출 시 영속성 컨텍스트에서 데이터를 가져오는건가요?
0
91
2
inheritance startegy 선택시 고려사항
0
58
1
Entity 동등성 비교
0
62
1
실무 조언 관련 질문입니다.
0
90
1
H2데이터베이스 파일 생성
0
101
2
서브쿼리 강의에서 ALL 예시 관련 질문드립니다.
1
91
2
수정또는 삭제시 영속성 엔티티에 값이 무조건 있어야 하나요?
0
82
1
JPQL 메소드와 락
0
76
1
Delivery @OneToOne
0
97
1
17강 4~5분대 테이블 값 조회가 안됩니다.
0
133
2
UnsupportedOperationException 발생
0
151
3
H2 Database 연결이 안됩니다.
0
125
2
연관관계 매핑 질문드립니다.
0
125
2
h2데이터베이스 실행오류
0
139
2
persistence.xml
0
149
2
양방향 연관관계에서 연관관계의 주인(mappedBy)을 왜 꼭 정해야 하나요?
0
116
1
영속성 컨텍스트
0
100
1
JPA 프록시
0
130
1
Native Query와 MyBatis
0
105
1
영속성 컨텍스트는 어떤 메모리에 저장되는건가요?
0
119
1
임베디드 타입 예시 코드 관련 질문
0
160
3