Fix: 예시 테스트 데이터 수정

UniBond-jijijin · Jan 2, 2024 · 8ae0d8a · 8ae0d8a
1 parent fb2a161
commit 8ae0d8a
Show file tree

Hide file tree

Showing 16 changed files with 3,097 additions and 304 deletions.
diff --git a/unibond/BOOT-INF/classes/static/docs/comment.html b/unibond/BOOT-INF/classes/static/docs/comment.html
diff --git a/unibond/BOOT-INF/classes/static/docs/community.html b/unibond/BOOT-INF/classes/static/docs/community.html
diff --git a/unibond/BOOT-INF/classes/static/docs/disease.html b/unibond/BOOT-INF/classes/static/docs/disease.html
@@ -506,32 +506,38 @@ <h3 id="_response"><a class="link" href="#_response">Response</a></h3>
 <div class="content">
 <pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
 Content-Type: application/json
-Content-Length: 978
+Content-Length: 1134
 
 {
   "isSuccess" : true,
   "code" : 1000,
   "message" : "요청에 성공하였습니다.",
   "result" : {
     "pageInfo" : {
+      "numberOfElements" : 5,
       "lastPage" : false,
       "totalPages" : 2,
       "totalElements" : 10,
       "size" : 5
     },
     "diseaseDataList" : [ {
+      "diseaseId" : 37,
       "diseaseNameKor" : "18번 염색체 장완의 결손 증후군",
       "diseaseNameEng" : "18q deletion syndrome"
     }, {
+      "diseaseId" : 52,
       "diseaseNameKor" : "18번 염색체 장완의 중복 증후군",
       "diseaseNameEng" : "18q duplication syndrome"
     }, {
+      "diseaseId" : 53,
       "diseaseNameKor" : "18번 염색체 단완의 사염색체증",
       "diseaseNameEng" : "Tetrasomy 18p"
     }, {
+      "diseaseId" : 57,
       "diseaseNameKor" : "8번 염색체 단완의 11.2 부분의 미세결손 증후군",
       "diseaseNameEng" : "8p11.2 deletion syndrome"
     }, {
+      "diseaseId" : 63,
       "diseaseNameKor" : "8번 염색체 단완의 역중복-결실 증후군",
       "diseaseNameEng" : "8p inverted duplication-deletion syndrome"
     } ]
@@ -579,6 +585,11 @@ <h3 id="_response"><a class="link" href="#_response">Response</a></h3>
 <td class="tableblock halign-left valign-top"><p class="tableblock">페이징 정보</p></td>
 </tr>
 <tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.pageInfo.numberOfElements</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">페이징 정보: 현재 페이지의 원소 개수</p></td>
+</tr>
+<tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.pageInfo.lastPage</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">페이징 정보: 마지막 페이지인지의 여부</p></td>
@@ -604,6 +615,11 @@ <h3 id="_response"><a class="link" href="#_response">Response</a></h3>
 <td class="tableblock halign-left valign-top"><p class="tableblock">검색된 질병 리스트</p></td>
 </tr>
 <tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.diseaseDataList[].diseaseId</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">검색된 질병 리스트: 질병 아이디</p></td>
+</tr>
+<tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.diseaseDataList[].diseaseNameKor</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">검색된 질병 리스트: 한글 질병 이름</p></td>

diff --git a/unibond/BOOT-INF/classes/static/docs/experience-community.html b/unibond/BOOT-INF/classes/static/docs/experience-community.html
@@ -474,87 +474,128 @@ <h2 id="_get_experience_community_posts"><a class="link" href="#_get_experience_
 <h3 id="_request"><a class="link" href="#_request">Request</a></h3>
 <div class="listingblock">
 <div class="content">
-<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/v1/community/experience HTTP/1.1
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/v1/community/experience?page=0 HTTP/1.1
 Content-Type: application/json;charset=UTF-8
 Host: localhost:8080</code></pre>
 </div>
 </div>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>page</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">조회할 페이지 [default: 0]</p></td>
+</tr>
+</tbody>
+</table>
 </div>
 <div class="sect2">
 <h3 id="_response"><a class="link" href="#_response">Response</a></h3>
 <div class="listingblock">
 <div class="content">
 <pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
 Content-Type: application/json;charset=UTF-8
-Content-Length: 3664
+Content-Length: 4849
 
 {
   "isSuccess" : true,
   "code" : 1000,
   "message" : "요청에 성공하였습니다.",
   "result" : {
-    "numberOfElements" : 7,
+    "pageInfo" : {
+      "numberOfElements" : 7,
+      "lastPage" : true,
+      "totalPages" : 1,
+      "totalElements" : 7,
+      "size" : 30
+    },
     "postPreviewList" : [ {
       "createdDate" : "2023-12-27T03:16:53.252948",
+      "ownerId" : 29,
       "ownerProfileImg" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/user/KakaoTalk_20230528_222457241_05.png",
       "ownerNick" : "5jizzi",
       "disease" : "13번 염색체 장완 21-22 부분의 결손",
+      "postId" : 26,
+      "postImg" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/post/31f7130c-b08e-48e3-ba0a-ebd791ecf960test-img.jpg",
       "contentPreview" : "경험 기록 게시판 게시물 업로드 테스트 5",
       "boardType" : "EXPERIENCE",
       "isEnd" : true
     }, {
       "createdDate" : "2023-12-26T04:09:10.8631",
+      "ownerId" : 31,
       "ownerProfileImg" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/user/8d1501fb-00f4-477d-ac4c-51e98ea6b3adSimulator%20Screenshot%20-%20iPhone%2015%20Pro%20-%202023-12-19%20at%2021.53.29.png",
       "ownerNick" : "GOGO",
       "disease" : "종양 괴사 인자 수용체와 관련된 주기성 증후군",
+      "postId" : 14,
+      "postImg" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/post/31f7130c-b08e-48e3-ba0a-ebd791ecf960test-img.jpg",
       "contentPreview" : "경험 기록 게시판 게시물 업로드 테스트 4",
       "boardType" : "EXPERIENCE",
       "isEnd" : true
     }, {
       "createdDate" : "2023-12-26T04:09:05.784257",
+      "ownerId" : 32,
       "ownerProfileImg" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/user/b0afd5ba-a19d-4913-b9c7-ff9dd7af2e82Simulator%20Screenshot%20-%20iPhone%2015%20Pro%20-%202023-12-31%20at%2018.06.36.png",
       "ownerNick" : "GOGO24",
       "disease" : "종양 괴사 인자 수용체와 관련된 주기성 증후군",
+      "postId" : 13,
+      "postImg" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/post/31f7130c-b08e-48e3-ba0a-ebd791ecf960test-img.jpg",
       "contentPreview" : "경험 기록 게시판 게시물 업로드 테스트 3",
       "boardType" : "EXPERIENCE",
       "isEnd" : true
     }, {
       "createdDate" : "2023-12-26T04:02:22.167476",
+      "ownerId" : 30,
       "ownerProfileImg" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/user/7289b49a-d89e-412b-8cd2-f3e617b4528e2560px-React-icon.svg.png",
       "ownerNick" : "12345",
       "disease" : "3번 염색체 장완 26 부분의 중복",
+      "postId" : 12,
+      "postImg" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/post/31f7130c-b08e-48e3-ba0a-ebd791ecf960test-img.jpg",
       "contentPreview" : "경험 기록 게시판 게시물 업로드 테스트 2",
       "boardType" : "EXPERIENCE",
       "isEnd" : true
     }, {
       "createdDate" : "2023-12-26T03:43:15.496574",
+      "ownerId" : 28,
       "ownerProfileImg" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/user/KakaoTalk_20230528_222457241_05.png",
       "ownerNick" : "asdf",
       "disease" : "13번 염색체 장완 21-22 부분의 결손",
+      "postId" : 11,
+      "postImg" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/post/31f7130c-b08e-48e3-ba0a-ebd791ecf960test-img.jpg",
       "contentPreview" : "경험 기록 게시판 게시물 업로드 테스트 1 ",
       "boardType" : "EXPERIENCE",
       "isEnd" : true
     }, {
       "createdDate" : "2023-11-16T14:18:33.129163",
+      "ownerId" : 31,
       "ownerProfileImg" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/user/8d1501fb-00f4-477d-ac4c-51e98ea6b3adSimulator%20Screenshot%20-%20iPhone%2015%20Pro%20-%202023-12-19%20at%2021.53.29.png",
       "ownerNick" : "GOGO",
       "disease" : "종양 괴사 인자 수용체와 관련된 주기성 증후군",
+      "postId" : 2,
+      "postImg" : null,
       "contentPreview" : "create post test by jiwon",
       "boardType" : "EXPERIENCE",
       "isEnd" : true
     }, {
       "createdDate" : "2023-11-16T13:55:27.91433",
+      "ownerId" : 32,
       "ownerProfileImg" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/user/b0afd5ba-a19d-4913-b9c7-ff9dd7af2e82Simulator%20Screenshot%20-%20iPhone%2015%20Pro%20-%202023-12-31%20at%2018.06.36.png",
       "ownerNick" : "GOGO24",
       "disease" : "종양 괴사 인자 수용체와 관련된 주기성 증후군",
+      "postId" : 1,
+      "postImg" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/post/31f7130c-b08e-48e3-ba0a-ebd791ecf960test-img.jpg",
       "contentPreview" : "create post test by jisoo",
       "boardType" : "EXPERIENCE",
       "isEnd" : true
-    } ],
-    "lastPage" : true,
-    "totalPages" : 1,
-    "totalElements" : 7,
-    "size" : 30
+    } ]
   }
 }</code></pre>
 </div>
@@ -594,9 +635,34 @@ <h3 id="_response"><a class="link" href="#_response">Response</a></h3>
 <td class="tableblock halign-left valign-top"><p class="tableblock">결과 데이터</p></td>
 </tr>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.numberOfElements</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.pageInfo</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Object</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">페이징 정보</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.pageInfo.numberOfElements</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">반환된 게시글 수</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">페이징 정보: 현재 페이지의 원소 개수</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.pageInfo.lastPage</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">페이징 정보: 마지막 페이지인지의 여부</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.pageInfo.totalPages</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">페이징 정보: 총 페이지 수</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.pageInfo.totalElements</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">페이징 정보: 총 검색 결과 개수</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.pageInfo.size</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">페이징 정보: 현재 페이지의 크기 [default: 30] - size는 parameter를 통해 전송하지 않는 것을 추천드립니다.</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.postPreviewList</code></p></td>
@@ -606,57 +672,52 @@ <h3 id="_response"><a class="link" href="#_response">Response</a></h3>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.postPreviewList[].createdDate</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">게시글 작성 일자</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">게시물 생성 시간</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.postPreviewList[].ownerId</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">게시물 작성자 아이디</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.postPreviewList[].ownerProfileImg</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">게시글 작성자 프로필 사진</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">게시물 작성자 프로필 이미지</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.postPreviewList[].ownerNick</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">게시글 작성자 닉네임</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">게시물 작성자 닉네임</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.postPreviewList[].disease</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">게시글 작성자의 질병</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">게시물 작성자 질병</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.postPreviewList[].postId</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">게시물 아이디</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.postPreviewList[].postImg</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">게시물 이미지</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.postPreviewList[].contentPreview</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">게시글 미리보기</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">게시물 미리 보기 내용</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.postPreviewList[].boardType</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">게시글 종류</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">게시판 종류</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.postPreviewList[].isEnd</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">미리보기로 제공된 게시글의 내용이 마지막인지 여부</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.lastPage</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">현재 마지막 페이지인지 여부</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.totalPages</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">총 페이지 수</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.totalElements</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">총 원소 개수</p></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>result.size</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">현재 페이지 사이즈</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">게시물 미리 보기 뒤에 내용이 더 있는지 여부 : 45자 이상일 경우 false / 아닐 경우 true</p></td>
 </tr>
 </tbody>
 </table>
@@ -817,7 +878,7 @@ <h3 id="_response_2"><a class="link" href="#_response_2">Response</a></h3>
 <div id="footer">
 <div id="footer-text">
 Version 0.0.1-SNAPSHOT<br>
-Last updated 2023-12-27 03:19:02 +0900
+Last updated 2024-01-01 07:25:25 +0900
 </div>
 </div>
 </body>

diff --git a/unibond/BOOT-INF/classes/static/docs/index.html b/unibond/BOOT-INF/classes/static/docs/index.html
@@ -530,8 +530,17 @@ <h3 id="_community"><a class="link" href="#_community">Community</a></h3>
 <div class="ulist">
 <ul>
 <li>
+<p><a href="community.html">Community API</a></p>
+</li>
+<li>
 <p><a href="experience-community.html">Experience Recording Community API</a></p>
 </li>
+<li>
+<p><a href="question-community.html">QnA Community API</a></p>
+</li>
+<li>
+<p><a href="comment.html">Comment API</a></p>
+</li>
 </ul>
 </div>
 </div>
@@ -555,7 +564,7 @@ <h3 id="_letter_rooms"><a class="link" href="#_letter_rooms">Letter Rooms</a></h
 <div id="footer">
 <div id="footer-text">
 Version 0.0.1-SNAPSHOT<br>
-Last updated 2023-12-31 04:53:18 +0900
+Last updated 2024-01-01 07:30:09 +0900
 </div>
 </div>
 </body>