docs : 수정사항 API 문서 반영

q-box-team · Nov 7, 2023 · c5f5ea5 · c5f5ea5
1 parent fdf6baa
commit c5f5ea5
Showing 1 changed file with 53 additions and 20 deletions.
diff --git a/src/main/resources/templates/api-docs.html b/src/main/resources/templates/api-docs.html
@@ -681,7 +681,7 @@ <h2 id="_답변_생성"><a class="link" href="#_답변_생성">답변 생성</a>
         <h3 id="_http_request"><a class="link" href="#_http_request">HTTP request</a></h3>
         <div class="listingblock">
           <div class="content">
-<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /answers?_csrf=8kIElLx0ZQ_aQknpFkEG-6a8NgJKwbQPUPhRgP_G7MjGVojTwnY18ItBUGz3cn3YJWwyzp-JGzp89NEiaZ415M-k2fHzNOm3 HTTP/1.1
+<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /answers?_csrf=qKkcDSF4gykP5owlGc1JmIBVE3UEn8nKnEQR0UK9rOGdcduYnpF-NBJJtRki07UXfOB9qrBmPk03-a3nqSEn43PYnIWqErj8 HTTP/1.1
 Content-Type: application/json;charset=UTF-8
 Content-Length: 53
 Host: localhost:8080
@@ -743,7 +743,7 @@ <h2 id="_학과_생성"><a class="link" href="#_학과_생성">학과 생성</a>
         <h3 id="_http_request_2"><a class="link" href="#_http_request_2">HTTP request</a></h3>
         <div class="listingblock">
           <div class="content">
-<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /departs?_csrf=xhdgPX9blBkvnJV7Jw-B6kaWHROYpIZUR6lBEueHI4MsFt0AonJYBR5toS8CqaBJFiK133evMHGvwLB5cJ0jJoXmF7pNJe5m HTTP/1.1
+<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /departs?_csrf=uU2GJJAVSBzL0NI1u3raRp8kf1kJsEU7_AHPz3Z7l1hYZrBg3CizF_EkeH_m4OQNjFfuc6dFUmBqgCcWyzb5rk9OoG8-UdQF HTTP/1.1
 Content-Type: application/json;charset=UTF-8
 Content-Length: 62
 Host: localhost:8080
@@ -907,7 +907,7 @@ <h2 id="_email_등록"><a class="link" href="#_email_등록">email 등록</a></h
         <h3 id="_http_request_4"><a class="link" href="#_http_request_4">HTTP request</a></h3>
         <div class="listingblock">
           <div class="content">
-<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /emails?_csrf=WPM7bc2RXxVQhDK4z42A8VOOQw6zj89Rag9heztwQcGLP1p9aJECCfX0PHd9tVOM9qC0xWrvbjaKtvd8WmpWSgNHd6SzCDwf HTTP/1.1
+<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /emails?_csrf=bpXfHLRGiYQnPn_K-hQM42S0ZrZZMnAeblmY34bH2RZIzx9yD_DpLtB3vrYKWE39zDk41weDS45rAxIzC238u-TyvCEt_ClC HTTP/1.1
 Content-Type: application/json;charset=UTF-8
 Content-Length: 33
 Host: localhost:8080
@@ -962,7 +962,7 @@ <h2 id="_email_키_인증"><a class="link" href="#_email_키_인증">email 키
         <h3 id="_http_request_5"><a class="link" href="#_http_request_5">HTTP request</a></h3>
         <div class="listingblock">
           <div class="content">
-<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /emails/key?_csrf=U0ILz_ahDSrKZWp4bYxaWIcOeG7S8TWfMR1gAHMEE8eELHRIMndprM-Za0vnBgwaVKFuObA6VVbjwQCyVS1QZktmJfHmTkV8 HTTP/1.1
+<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /emails/key?_csrf=q_Mxzmx5leSt9R-COgaqCCkJZOqyYPWJh9K-zFXyJV0kCCCtk5EI-ggYpYGAxC7gCSueMBgxSdLWU8Wks-rYrTCXQGRHPxKd HTTP/1.1
 Content-Type: application/json;charset=UTF-8
 Content-Length: 24
 Host: localhost:8080
@@ -1015,7 +1015,7 @@ <h2 id="_강의_생성"><a class="link" href="#_강의_생성">강의 생성</a>
         <h3 id="_http_request_6"><a class="link" href="#_http_request_6">HTTP request</a></h3>
         <div class="listingblock">
           <div class="content">
-<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /lectures?_csrf=jJY9BVtRhpgfmO5pBCDrAZAjOrY-1BBG2Jk44mNn-xdPAylVtK8JZD8wsKwyrtwMPA3fN_QXF9dY5CFrvagNh1VQmi97M0sz HTTP/1.1
+<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /lectures?_csrf=Dlf8unNL3Vs3ZDj3ClI-Nlhsk9K7AJQVZbnjfagF5KdQBb8nPDTO2UB6vmMaVArCbn8KVW5avuqJYvI4VNrQH5w3hpRgNY9G HTTP/1.1
 Content-Type: application/json;charset=UTF-8
 Content-Length: 68
 Host: localhost:8080
@@ -1192,7 +1192,7 @@ <h2 id="_질문_생성"><a class="link" href="#_질문_생성">질문 생성</a>
         <h3 id="_http_request_8"><a class="link" href="#_http_request_8">HTTP request</a></h3>
         <div class="listingblock">
           <div class="content">
-<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /questions?_csrf=NpMlmwgBQGugFCVaaRg1FNfa20oeqCm-VUQfyt0913LUxIOfUKEU-T9gdFiNckY-DDUBJ7Xq9isvnUuTNiAs_r4Jsha3orH5 HTTP/1.1
+<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /questions?_csrf=XBW2Qls1fyREBKM3fW7xTH4WUOiMiku04u8zh9BpyS7R3YSubCfTJz1RSEdpNZoDGUPFKB8lfYrosnmZ1dsBtLMPqEzpvrTM HTTP/1.1
 Content-Type: application/json;charset=UTF-8
 Content-Length: 112
 Host: localhost:8080
@@ -1295,7 +1295,7 @@ <h2 id="_대학_생성"><a class="link" href="#_대학_생성">대학 생성</a>
         <h3 id="_http_request_9"><a class="link" href="#_http_request_9">HTTP request</a></h3>
         <div class="listingblock">
           <div class="content">
-<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /univ?_csrf=CuNQTAtUhyCwpPtdL1ihqN5IXvpZVZMnpH8zvInYpfyaDzsHaNRlezg1sROdwMw-TnWVn717c8NuYaoKlB0GjLy9l577bQNm HTTP/1.1
+<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /univ?_csrf=juTPxvymqXoF0IaD_Ds6Zm91qUNLedy5WkXg5fVbU6K8PaiP6ICr8JienUIo6ba0xBYOU1lEhCF8H-6UYnDW1MZqZMaEX5zr HTTP/1.1
 Content-Type: application/json;charset=UTF-8
 Content-Length: 62
 Host: localhost:8080
@@ -1384,7 +1384,7 @@ <h2 id="_회원가입"><a class="link" href="#_회원가입">회원가입</a></h
         <h3 id="_http_request_10"><a class="link" href="#_http_request_10">HTTP request</a></h3>
         <div class="listingblock">
           <div class="content">
-<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /members?_csrf=9uHiEUFtgaL8uKZw8piP2AVZcV9FcJx0N8iySN8weW6n2IJ7z9GHJ3UI5JTRisIWkbW77zBtXD4hFKlZD_jXe74CG12QvuMa HTTP/1.1
+<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /members?_csrf=vGWy1mnjnc-w-Qn8fQeBe5qY_A4Mi1yXYW-mVA_ipp2XzZs-jgbR5F2B_66dwTjMHyq1Tfmg0Tc7vji6VQvDMmnTn6-nrvkM HTTP/1.1
 Content-Type: application/json;charset=UTF-8
 Content-Length: 96
 Host: localhost:8080
@@ -1539,7 +1539,7 @@ <h2 id="_question_생성"><a class="link" href="#_question_생성">question 생
         <h3 id="_http_request_12"><a class="link" href="#_http_request_12">HTTP request</a></h3>
         <div class="listingblock">
           <div class="content">
-<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /questions?_csrf=NpMlmwgBQGugFCVaaRg1FNfa20oeqCm-VUQfyt0913LUxIOfUKEU-T9gdFiNckY-DDUBJ7Xq9isvnUuTNiAs_r4Jsha3orH5 HTTP/1.1
+<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /questions?_csrf=XBW2Qls1fyREBKM3fW7xTH4WUOiMiku04u8zh9BpyS7R3YSubCfTJz1RSEdpNZoDGUPFKB8lfYrosnmZ1dsBtLMPqEzpvrTM HTTP/1.1
 Content-Type: application/json;charset=UTF-8
 Content-Length: 112
 Host: localhost:8080
@@ -1641,7 +1641,7 @@ <h2 id="_question_목록_조회"><a class="link" href="#_question_목록_조회"
         <h3 id="_http_request_13"><a class="link" href="#_http_request_13">HTTP request</a></h3>
         <div class="listingblock">
           <div class="content">
-<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">GET /questions?code=code&amp;depart=5&amp;size=100&amp;page=0 HTTP/1.1
+<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">GET /questions?lectureCode=code&amp;lectureDepart=5&amp;title=title&amp;body=body&amp;writerNickname=writerNick&amp;size=100&amp;page=0 HTTP/1.1
 Host: localhost:8080</code></pre>
           </div>
         </div>
@@ -1658,11 +1658,23 @@ <h3 id="_http_request_13"><a class="link" href="#_http_request_13">HTTP request<
           </thead>
           <tbody>
           <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>title</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>body</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>writerNickname</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>lectureCode</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>depart</code></p></td>
+            <td class="tableblock halign-left valign-top"><p class="tableblock"><code>lectureDepart</code></p></td>
             <td class="tableblock halign-left valign-top"><p class="tableblock">강의 해당 학과 ID</p></td>
           </tr>
           <tr>
@@ -1688,36 +1700,40 @@ <h3 id="_http_response_13"><a class="link" href="#_http_response_13">HTTP respon
 Pragma: no-cache
 Expires: 0
 X-Frame-Options: DENY
-Content-Length: 454
+Content-Length: 638
 
 [ {
   "id" : 1,
   "title" : "제목1",
   "writer" : {
     "email" : "[email protected]",
     "nickname" : "닉넴"
-  }
+  },
+  "createdAt" : "2023-11-07T22:19:19.758352"
 }, {
   "id" : 2,
   "title" : "제목2",
   "writer" : {
     "email" : "[email protected]",
     "nickname" : "닉넴"
-  }
+  },
+  "createdAt" : "2023-11-07T22:19:19.758361"
 }, {
   "id" : 3,
   "title" : "제목3",
   "writer" : {
     "email" : "[email protected]",
     "nickname" : "닉넴"
-  }
+  },
+  "createdAt" : "2023-11-07T22:19:19.758362"
 }, {
   "id" : 4,
   "title" : "제목4",
   "writer" : {
     "email" : "[email protected]",
     "nickname" : "닉넴"
-  }
+  },
+  "createdAt" : "2023-11-07T22:19:19.758362"
 } ]</code></pre>
           </div>
         </div>
@@ -1755,6 +1771,11 @@ <h3 id="_http_response_13"><a class="link" href="#_http_response_13">HTTP respon
             <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>[].createdAt</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>
@@ -1784,7 +1805,7 @@ <h3 id="_http_response_14"><a class="link" href="#_http_response_14">HTTP respon
 Pragma: no-cache
 Expires: 0
 X-Frame-Options: DENY
-Content-Length: 226
+Content-Length: 318
 
 {
   "id" : 5,
@@ -1798,7 +1819,9 @@ <h3 id="_http_response_14"><a class="link" href="#_http_response_14">HTTP respon
   "writer" : {
     "email" : "[email protected]",
     "nickname" : "닉넴"
-  }
+  },
+  "createdAt" : "2023-11-07T22:19:19.830026",
+  "updatedAt" : "2023-11-07T22:19:19.830033"
 }</code></pre>
           </div>
         </div>
@@ -1854,7 +1877,17 @@ <h3 id="_http_response_14"><a class="link" href="#_http_response_14">HTTP respon
           <tr>
             <td class="tableblock halign-left valign-top"><p class="tableblock"><code>writer.nickname</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>createdAt</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>updatedAt</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>