docs: RestDocumentation 추가

back/src/docs/api-docs.adoc

@@ -0,0 +1,49 @@
+ifndef::snippets[]
+:snippets: ../../../build/generated-snippets
+endif::[]
+:toc: preamble
+:toc-title: 목차
+:toclevels: 2
+:doctitle: 셀러리 API
+:author: 터틀
+:email: begaonnuri@gmail.com
+
+Doc Writer <{author} : {email}>
+
+[[resources-member]]
+== 회원 관리
+
+=== 회원 로그인
+
+operation::login[snippets='http-request,http-response,request-fields,request-body']
+
+=== 회원 로그인 실패
+
+==== 이메일
+
+operation::login/advice/email[snippets='http-request,http-response,request-fields,request-body,response-body']
+
+==== 비밀번호
+
+operation::login/advice/password[snippets='http-request,http-response,request-fields,request-body,response-body']
+
+[[resources-articles]]
+== 게시글 관리
+
+=== 게시글 페이지 조회
+
+operation::articles/getPage[snippets='http-request,http-response,request-parameters,response-body']
+
+=== 게시글 상세 조회
+
+operation::articles/get[snippets='http-request,http-response,path-parameters,request-parameters,response-body']
+
+=== 게시글 생성
+
+operation::articles/post[snippets='http-request,http-response,request-body,response-headers']
+
+== 채팅방 관리
+
+=== 채팅방 생성
+
+operation::chat-rooms/post[snippets='http-request,http-response,request-fields,request-body,response-headers']

back/src/test/java/sellerlee/back/article/presentation/ArticleControllerTest.java

@@ -82,12 +82,16 @@ void createArticle() throws Exception {
                                         .description("게시글의 제목"),
                                 fieldWithPath("category").type(JsonFieldType.STRING)
                                         .description("게시글의 카테고리"),
-                                fieldWithPath("contents").type(JsonFieldType.NUMBER)
+                                fieldWithPath("contents").type(JsonFieldType.STRING)
                                         .description("게시글의 내용"),
                                 fieldWithPath("price").type(JsonFieldType.NUMBER)
                                         .description("게시글의 가격"),
-                                fieldWithPath("tradeState").type(JsonFieldType.STRING)
-                                        .description("게시글의 판매 상태"),
+                                // fieldWithPath("tradeState").type(JsonFieldType.STRING)
+                                //         .description("게시글의 판매 상태"),
+                                fieldWithPath("tradeType").type(JsonFieldType.STRING)
+                                        .description("게시글의 거래 유형"),
+                                fieldWithPath("tradeLocation").type(JsonFieldType.STRING)
+                                        .description("게시글의 거래 지역"),
                                 fieldWithPath("tags").type(JsonFieldType.ARRAY)
                                         .description("태그의 리스트"),
                                 fieldWithPath("photos").type(JsonFieldType.ARRAY)
@@ -120,6 +124,18 @@ void showPage() throws Exception {
                         requestParameters(
                                 parameterWithName("lastArticleId").description("마지막 게시글의 ID"),
                                 parameterWithName("size").description("가져올 페이지의 크기(게시물 수)")
+                        ),
+                        responseFields(
+                                fieldWithPath("[].id").type(JsonFieldType.NUMBER)
+                                        .description("게시글의 ID"),
+                                fieldWithPath("[].price").type(JsonFieldType.NUMBER)
+                                        .description("게시글의 가격"),
+                                fieldWithPath("[].favoriteCount").type(JsonFieldType.NUMBER)
+                                        .description("게시글의 찜 개수"),
+                                fieldWithPath("[].tags").type(JsonFieldType.ARRAY)
+                                        .description("태그의 리스트"),
+                                fieldWithPath("[].photos").type(JsonFieldType.ARRAY)
+                                        .description("사진의 리스트")
                         )
                 ));
     }
@@ -132,11 +148,14 @@ void showArticle() throws Exception {
 
         // URI Path variable을 가져와야 해서 RestDocumentationRequestBuilders.get()을 사용했음
         mockMvc.perform(
-                RestDocumentationRequestBuilders.get(ARTICLE_URI + "/{id}", ARTICLE1.getId())
+                RestDocumentationRequestBuilders
+                        .get(ARTICLE_URI + "/{id}", ARTICLE1.getId())
                         .param("memberId", String.valueOf(MEMBER1.getId())))
                 .andDo(print())
                 .andExpect(status().isOk())
                 .andDo(document("articles/get",
+                        preprocessRequest(prettyPrint()),
+                        preprocessResponse(prettyPrint()),
                         // requestHeaders(
                         //         headerWithName("Authorization").description("회원의 토큰")
                         // ),
@@ -145,6 +164,38 @@ void showArticle() throws Exception {
                         ),
                         pathParameters(
                                 parameterWithName("id").description("게시글의 ID")
+                        ),
+                        responseFields(
+                                fieldWithPath("id").type(JsonFieldType.NUMBER)
+                                        .description("게시글의 ID"),
+                                fieldWithPath("title").type(JsonFieldType.STRING)
+                                        .description("게시글의 제목"),
+                                fieldWithPath("category").type(JsonFieldType.STRING)
+                                        .description("게시글의 카테고리"),
+                                fieldWithPath("contents").type(JsonFieldType.STRING)
+                                        .description("게시글의 내용"),
+                                fieldWithPath("price").type(JsonFieldType.NUMBER)
+                                        .description("게시글의 가격"),
+                                fieldWithPath("tradeType").type(JsonFieldType.STRING)
+                                        .description("게시글의 거래 유형"),
+                                fieldWithPath("tradeLocation").type(JsonFieldType.STRING)
+                                        .description("게시글의 거래 지역"),
+                                fieldWithPath("tradeState").type(JsonFieldType.STRING)
+                                        .description("게시글의 판매 상태"),
+                                fieldWithPath("photos").type(JsonFieldType.ARRAY)
+                                        .description("사진의 리스트"),
+                                fieldWithPath("author.avatar").type(JsonFieldType.STRING)
+                                        .description("게시글 작성자의 프로필 사진"),
+                                fieldWithPath("author.nickname").type(JsonFieldType.STRING)
+                                        .description("게시글 작성자의 닉네임"),
+                                fieldWithPath("author.score").type(JsonFieldType.NUMBER)
+                                        .description("게시글 작성자의 점수"),
+                                fieldWithPath("favoriteState").type(JsonFieldType.BOOLEAN)
+                                        .description("작성자의 게시글 찜 여부"),
+                                fieldWithPath("favoriteCount").type(JsonFieldType.NUMBER)
+                                        .description("게시글의 찜 개수"),
+                                fieldWithPath("createdTime").type(JsonFieldType.STRING)
+                                        .description("게시글 생성 시간")
                         )
                 ));
     }

back/src/test/java/sellerlee/back/chatroom/presentation/ChatRoomControllerTest.java

@@ -1,7 +1,3 @@
-/**
- * @author kouz95
- */
-
 package sellerlee.back.chatroom.presentation;
 
 import static org.mockito.ArgumentMatchers.*;
@@ -75,6 +71,7 @@ void createChatRoom() throws Exception {
                 .andExpect(status().isCreated())
                 .andDo(document("chat-rooms/post",
                         preprocessRequest(prettyPrint()),
+                        preprocessResponse(prettyPrint()),
                         // requestHeaders(
                         //         headerWithName("Authorization").description("회원의 토큰")
                         // ),
@@ -101,6 +98,7 @@ void showChatRoomOfArticle() throws Exception {
                 .param("articleId", "1"))
                 .andExpect(status().isOk())
                 .andDo(document("chat-rooms/",
+                        preprocessRequest(prettyPrint()),
                         preprocessResponse(prettyPrint()),
                         // requestHeaders(
                         //         headerWithName("Authorization").description("회원의 토큰")

back/src/test/java/sellerlee/back/member/presentation/LoginAdviceControllerTest.java

@@ -2,6 +2,7 @@
 
 import static org.mockito.Mockito.*;
 import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.*;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.*;
 import static org.springframework.restdocs.payload.PayloadDocumentation.*;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
 import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.*;
@@ -64,6 +65,8 @@ void handleIllegalMemberLoginException_InvalidEmail() throws Exception {
                 .andDo(print())
                 .andExpect(status().isBadRequest())
                 .andDo(document("login/advice/email",
+                        preprocessRequest(prettyPrint()),
+                        preprocessResponse(prettyPrint()),
                         requestFields(
                                 fieldWithPath("email").type(JsonFieldType.STRING)
                                         .description("사용자가 입력한 이메일"),
@@ -88,6 +91,8 @@ void handleIllegalMemberLoginException_InvalidPassword() throws Exception {
                 .accept(MediaType.APPLICATION_JSON))
                 .andExpect(status().isBadRequest())
                 .andDo(document("login/advice/password",
+                        preprocessRequest(prettyPrint()),
+                        preprocessResponse(prettyPrint()),
                         requestFields(
                                 fieldWithPath("email").description("사용자가 입력한 이메일"),
                                 fieldWithPath("password").description("사용자가 입력한 비밀번호")

back/src/test/java/sellerlee/back/member/presentation/MemberControllerTest.java

@@ -1,11 +1,8 @@
-/**
- * @author lxxjn0
- */
-
 package sellerlee.back.member.presentation;
 
 import static org.mockito.Mockito.*;
 import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.*;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.*;
 import static org.springframework.restdocs.payload.PayloadDocumentation.*;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
 import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.*;
@@ -61,6 +58,8 @@ void login() throws Exception {
                 .accept(MediaType.APPLICATION_JSON))
                 .andExpect(status().isOk())
                 .andDo(document("login",
+                        preprocessRequest(prettyPrint()),
+                        preprocessResponse(prettyPrint()),
                         requestFields(
                                 fieldWithPath("email").description("사용자가 입력한 이메일"),
                                 fieldWithPath("password").description("사용자가 입력한 비밀번호")