Chore: API docs html 업데이트

UniBond-jijijin · Dec 30, 2023 · cdd8fbd · cdd8fbd
1 parent 90a559f
commit cdd8fbd
Show file tree

Hide file tree

Showing 7 changed files with 229 additions and 12 deletions.
diff --git a/unibond/BOOT-INF/classes/static/docs/disease.html b/unibond/BOOT-INF/classes/static/docs/disease.html
@@ -470,7 +470,7 @@ <h3 id="_request"><a class="link" href="#_request">Request</a></h3>
 <div class="content">
 <pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/v1/diseases/search?lan=kor&amp;query=8%EB%B2%88+%EC%97%BC%EC%83%89%EC%B2%B4&amp;page=0 HTTP/1.1
 Content-Type: application/json;charset=UTF-8
-Host: docs.api.com:8080</code></pre>
+Host: localhost:8080</code></pre>
 </div>
 </div>
 <table class="tableblock frame-all grid-all stretch">

diff --git a/unibond/BOOT-INF/classes/static/docs/letter-rooms.html b/unibond/BOOT-INF/classes/static/docs/letter-rooms.html
@@ -454,6 +454,12 @@ <h1>Member API</h1>
 <li><a href="#_response">Response</a></li>
 </ul>
 </li>
+<li><a href="#_get_all_letters_in_letter_rooms">Get All Letters in Letter Rooms</a>
+<ul class="sectlevel2">
+<li><a href="#_request_2">Request</a></li>
+<li><a href="#_response_2">Response</a></li>
+</ul>
+</li>
 </ul>
 </div>
 </div>
@@ -471,7 +477,7 @@ <h3 id="_request"><a class="link" href="#_request">Request</a></h3>
 <pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/v1/letter-rooms?page=0 HTTP/1.1
 Content-Type: application/json;charset=UTF-8
 Authorization: 3
-Host: docs.api.com:8080</code></pre>
+Host: localhost:8080</code></pre>
 </div>
 </div>
 <table class="tableblock frame-all grid-all stretch">
@@ -623,11 +629,186 @@ <h3 id="_response"><a class="link" href="#_response">Response</a></h3>
 </div>
 </div>
 </div>
+<div class="sect1">
+<h2 id="_get_all_letters_in_letter_rooms"><a class="link" href="#_get_all_letters_in_letter_rooms">Get All Letters in Letter Rooms</a></h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>참여 중인 편지방 내부의 편지들 가져오기</p>
+</div>
+<div class="sect2">
+<h3 id="_request_2"><a class="link" href="#_request_2">Request</a></h3>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/v1/letter-rooms/9?page=0 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Authorization: 2
+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_2"><a class="link" href="#_response_2">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
+Content-Length: 725
+
+{
+  "isSuccess" : true,
+  "code" : 1000,
+  "message" : "요청에 성공하였습니다.",
+  "result" : {
+    "receiverProfileImg" : "http://testimg2",
+    "receiverName" : "jiny",
+    "receiverDiseaseName" : "7번 염색체 장완 36 부분의 미세결손 증후군",
+    "receiverDiagnosisTiming" : "2013-11-10",
+    "pageInfo" : {
+      "lastPage" : true,
+      "totalPages" : 1,
+      "totalElements" : 2,
+      "size" : 30
+    },
+    "letterList" : [ {
+      "senderName" : "jiny",
+      "sentDate" : "2023-11-11T00:46:29.911363",
+      "letterTitle" : "title 2"
+    }, {
+      "senderName" : "lucy",
+      "sentDate" : "2023-11-11T00:46:24.69997",
+      "letterTitle" : "title 1"
+    } ]
+  }
+}</code></pre>
+</div>
+</div>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 33.3333%;">
+<col style="width: 33.3333%;">
+<col style="width: 33.3334%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</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>isSuccess</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>code</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>message</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</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.receiverProfileImg</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.receiverName</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.receiverDiseaseName</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.receiverDiagnosisTiming</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.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.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.letterList</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Array</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.letterList[].senderName</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.letterList[].sentDate</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.letterList[].letterTitle</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>
+</tbody>
+</table>
+</div>
+</div>
+</div>
 </div>
 <div id="footer">
 <div id="footer-text">
 Version 0.0.1-SNAPSHOT<br>
-Last updated 2023-12-31 04:07:52 +0900
+Last updated 2023-12-31 04:39:02 +0900
 </div>
 </div>
 </body>

diff --git a/unibond/BOOT-INF/classes/static/docs/member.html b/unibond/BOOT-INF/classes/static/docs/member.html
@@ -615,7 +615,7 @@ <h3 id="_response"><a class="link" href="#_response">Response</a></h3>
   "code" : 1000,
   "message" : "요청에 성공하였습니다.",
   "result" : {
-    "profileImage" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/user/5ee7f42a-219f-4d27-8978-cb6d1b8186edtest_profile_img.jpg",
+    "profileImage" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/user/ec2cb752-c710-47b9-a01b-0b5c9ea7357atest_profile_img.jpg",
     "nickname" : "5jizzi",
     "gender" : "MALE",
     "diseaseName" : "1번 염색체 장완 21.3 부분의 미세결손 증후군",

diff --git a/unibond/src/main/resources/static/docs/disease.html b/unibond/src/main/resources/static/docs/disease.html
@@ -6,7 +6,7 @@
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="generator" content="Asciidoctor 2.0.10">
 <meta name="author" content="Lucy Oh">
-<title>Member API</title>
+<title>Disease API</title>
 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
 <style>
 /* Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
@@ -440,7 +440,7 @@
 </head>
 <body class="book toc2 toc-left">
 <div id="header">
-<h1>Member API</h1>
+<h1>Disease API</h1>
 <div class="details">
 <span id="author" class="author">Lucy Oh</span><br>
 <span id="revnumber">version 0.0.1-SNAPSHOT</span>
@@ -622,7 +622,7 @@ <h3 id="_response"><a class="link" href="#_response">Response</a></h3>
 <div id="footer">
 <div id="footer-text">
 Version 0.0.1-SNAPSHOT<br>
-Last updated 2023-12-31 03:53:40 +0900
+Last updated 2023-12-31 04:53:57 +0900
 </div>
 </div>
 </body>

diff --git a/unibond/src/main/resources/static/docs/index.html b/unibond/src/main/resources/static/docs/index.html
@@ -555,7 +555,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:06:59 +0900
+Last updated 2023-12-31 04:53:18 +0900
 </div>
 </div>
 </body>

diff --git a/unibond/src/main/resources/static/docs/letter-rooms.html b/unibond/src/main/resources/static/docs/letter-rooms.html
@@ -6,7 +6,7 @@
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="generator" content="Asciidoctor 2.0.10">
 <meta name="author" content="Lucy Oh">
-<title>Member API</title>
+<title>Letter Room API</title>
 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
 <style>
 /* Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
@@ -440,7 +440,7 @@
 </head>
 <body class="book toc2 toc-left">
 <div id="header">
-<h1>Member API</h1>
+<h1>Letter Room API</h1>
 <div class="details">
 <span id="author" class="author">Lucy Oh</span><br>
 <span id="revnumber">version 0.0.1-SNAPSHOT</span>
@@ -537,6 +537,24 @@ <h3 id="_response"><a class="link" href="#_response">Response</a></h3>
 </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">Name</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>Authorization</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Basic auth credentials</p></td>
+</tr>
+</tbody>
+</table>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
 <col style="width: 33.3333%;">
 <col style="width: 33.3333%;">
 <col style="width: 33.3334%;">
@@ -652,6 +670,24 @@ <h3 id="_request_2"><a class="link" href="#_request_2">Request</a></h3>
 </colgroup>
 <thead>
 <tr>
+<th class="tableblock halign-left valign-top">Name</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>Authorization</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Basic auth credentials</p></td>
+</tr>
+</tbody>
+</table>
+<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>
@@ -808,7 +844,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-31 04:39:02 +0900
+Last updated 2023-12-31 04:53:41 +0900
 </div>
 </div>
 </body>

diff --git a/unibond/src/main/resources/static/docs/member.html b/unibond/src/main/resources/static/docs/member.html
@@ -615,7 +615,7 @@ <h3 id="_response"><a class="link" href="#_response">Response</a></h3>
   "code" : 1000,
   "message" : "요청에 성공하였습니다.",
   "result" : {
-    "profileImage" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/user/ec2cb752-c710-47b9-a01b-0b5c9ea7357atest_profile_img.jpg",
+    "profileImage" : "https://unibond-img-bucket.s3.ap-northeast-2.amazonaws.com/user/7b7a3e8e-e2f4-4b34-84fe-33cddd8a2256test_profile_img.jpg",
     "nickname" : "5jizzi",
     "gender" : "MALE",
     "diseaseName" : "1번 염색체 장완 21.3 부분의 미세결손 증후군",