Spring MVC(API 문서화 실습)

Rina's·2023년 7월 3일

코드스테이츠

목록 보기
59/96
post-thumbnail

get 맴버 전체를 조회

이전과 달리 member -> MemberResponse 매퍼가 MockBean 등록되어 있었기 때문에 관련한 given()을 새로 정의해 줘야 했다

전체조회는 페이지네이션이 적용되어있기 때문에 willReturn() 에 넣어줄 Page<> 객체를 추가로 만든다.
배열은 '0'부터 시작되나 보통 시작을 1로 잡기 때문에 page 값보다 -1 해준다

마지막 willReturn() 만 실제 값을 가지면 된다. 보다 이전에 리턴받는 객체는
빈 객체new LinkedList<>(List.of(new Member(), new Member()) 를 생성했다. 단 페이지 정보를 맞추기 위해 빈 객체의 수와 실제 객체의 수는 맞춰준다

perform() 시 파라미터 값을 잊지 말고 추가하자

parameterWithName() 로 문서에도 요청 파라미터 정보를 추가하자
전체조회에서 data는 OBJECT가 아닌 Object[]가 됨으로 ARRAY로 설정한다
페이지네이션에 대한 정보도 추가한다

테스트 케이스를 패스하고
adoc 파일을 include:: 매크로로 스니펫을 등록한 후 html파일로 빌더한다

같은 이름의 메서드에 주의
MockMvc.perform().get()
Spring MVC 컨트롤러의 테스트를 수행할 때 기본적으로 사용되는 MockMvc 라이브러리의 get
RestDocumentationRequestBuilders.get()
Spring REST Docs 라이브러리의 get, @AutoConfigureRestDocs 와 함께 문서화를 위해 사용

profile
갭린이 리나

0개의 댓글