2023.01.09.MON

[Spring Rest Docs로 API 문서화 실습]

• getResponsePreProcessor() 이용하면 body의 JSON 부분이 1줄이 아니라 여러 줄로 예쁘게 표시됨
• Controller의 핸들러 메서드의 모든 리턴값을 stub 데이터로 줘야함.
• 리턴값이 배열인 경우, fieldWithPath("data[]")로 property 표시.

.andDo(document(
                        "get-members",
                        getResponsePreProcessor(),
                        requestParameters(
                                parameterWithName("page").description("페이지 번호"),
                                parameterWithName("size").description("요청 요소 갯수")),
                        responseFields(
                                List.of(
                                        fieldWithPath("data[]").type(JsonFieldType.ARRAY).description("전체 회원 정보"),
                                        fieldWithPath("data[].memberId").type(JsonFieldType.NUMBER).description("아이디"))));

• property의 유효성 검사 속성도 API 문서에 포함할 수 있다.
  https://techblog.woowahan.com/2597/
  https://velog.io/@dae-hwa/REST-Docs%EC%97%90-DTO%EC%9D%98-Validation-%EC%A0%95%EB%B3%B4-%EB%8B%B4%EA%B8%B0

<느낀 점>
아직 프로그래머스 0단계 쉬운 문제를 풀고 있어서 따로 블로깅을 하지는 않지만, 아침마다 차근히 풀고 있다.
다른 사람들 푸는 방법을 보니, Stream을 더 잘 쓰면 좋을 것 같은데 아직 어렵다.

오늘은 Spring Rest Docs로 API 문서화 실습을 했고, documentation이 그렇게 어렵지는 않다.
리턴값에 여러 값이 들어가면 까먹지 않고 stub 데이터를 넣어줘야 한다는 것과, 필드가 배열일 경우 제이슨 경로를 나타내는 방법을 배웠다.
필드의 유효성 검사 속성을 API 문서에 추가하는 방법은 아직 제대로 이해 못했다.