Skip to content

Commit

Permalink
[ADD] RestDocs page update
Browse files Browse the repository at this point in the history
  • Loading branch information
@Kim-Dong-Jun99
Kim-Dong-Jun99 committed Jul 4, 2023
1 parent 783a06a commit 1102ef3
Showing 1 changed file with 127 additions and 27 deletions.
154 changes: 127 additions & 27 deletions src/main/resources/templates/api_doc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -452,42 +452,43 @@ <h1>Uliga Backend REST Docs</h1>
<ul class="sectlevel2">
<li><a href="#_email_certification">Email Certification</a>
<ul class="sectlevel3">
<li><a href="#_success">Success</a></li>
<li><a href="#_fail">Fail</a></li>
<li><a href="#_success"><code><strong><em>Success</em></strong></code></a></li>
<li><a href="#_fail"><code><strong><em>Fail</em></strong></code></a></li>
</ul>
</li>
<li><a href="#_duplicate_email_check">Duplicate Email Check</a>
<ul class="sectlevel3">
<li><a href="#_success_2">Success</a></li>
<li><a href="#_fail_2">Fail</a></li>
<li><a href="#_success_2"><code><strong><em>Success</em></strong></code></a></li>
<li><a href="#_fail_2"><code><strong><em>Fail</em></strong></code></a></li>
</ul>
</li>
<li><a href="#_duplicate_nickname_check">Duplicate Nickname Check</a>
<ul class="sectlevel3">
<li><a href="#_success_3">Success</a></li>
<li><a href="#_fail_3">Fail</a></li>
<li><a href="#_success_3"><code><strong><em>Success</em></strong></code></a></li>
<li><a href="#_fail_3"><code><strong><em>Fail</em></strong></code></a></li>
</ul>
</li>
<li><a href="#_signup">Signup</a>
<ul class="sectlevel3">
<li><a href="#_success_4">Success</a></li>
<li><a href="#_fail_4">Fail</a></li>
<li><a href="#_success_4"><code><strong><em>Success</em></strong></code></a></li>
<li><a href="#_fail_4"><code><strong><em>Fail</em></strong></code></a></li>
</ul>
</li>
<li><a href="#_login">Login</a>
<ul class="sectlevel3">
<li><a href="#_success_5">Success</a></li>
<li><a href="#_success_5"><code><strong><em>Success</em></strong></code></a></li>
<li><a href="#_fail_5"><code><strong><em>Fail</em></strong></code></a></li>
</ul>
</li>
<li><a href="#_oauth_signup">Oauth Signup</a>
<ul class="sectlevel3">
<li><a href="#_success_6">Success</a></li>
<li><a href="#_success_6"><code><strong><em>Success</em></strong></code></a></li>
</ul>
</li>
<li><a href="#_token_reissue">Token Reissue</a>
<ul class="sectlevel3">
<li><a href="#_success_7">Success</a></li>
<li><a href="#_fail_5">Fail</a></li>
<li><a href="#_success_7"><code><strong><em>Success</em></strong></code></a></li>
<li><a href="#_fail_6"><code><strong><em>Fail</em></strong></code></a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -584,7 +585,6 @@ <h2 id="overview_http_status_codes"><a class="link" href="#overview_http_status_
</tr>
</tbody>
</table>
<hr>
</div>
</div>
<div class="sect1">
Expand All @@ -593,7 +593,7 @@ <h2 id="_auth_api"><a class="link" href="#_auth_api">Auth API</a></h2>
<div class="sect2">
<h3 id="_email_certification"><a class="link" href="#_email_certification">Email Certification</a></h3>
<div class="sect3">
<h4 id="_success"><a class="link" href="#_success">Success</a></h4>
<h4 id="_success"><a class="link" href="#_success"><code><strong><em>Success</em></strong></code></a></h4>
<div class="paragraph">
<p><strong>요청 필드</strong></p>
</div>
Expand Down Expand Up @@ -675,9 +675,10 @@ <h4 id="_success"><a class="link" href="#_success">Success</a></h4>
{"matches":true}</code></pre>
</div>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="_fail"><a class="link" href="#_fail">Fail</a></h4>
<h4 id="_fail"><a class="link" href="#_fail"><code><strong><em>Fail</em></strong></code></a></h4>
<div class="paragraph">
<p><code><strong><em>Expired code</em></strong></code></p>
</div>
Expand Down Expand Up @@ -767,6 +768,7 @@ <h4 id="_fail"><a class="link" href="#_fail">Fail</a></h4>
{"errorCode":409,"message":"만료돤 이메일 인증 코드입니다."}</code></pre>
</div>
</div>
<hr>
<div class="paragraph">
<p><code><strong><em>Wrong code</em></strong></code></p>
</div>
Expand Down Expand Up @@ -851,6 +853,7 @@ <h4 id="_fail"><a class="link" href="#_fail">Fail</a></h4>
{"matches":false}</code></pre>
</div>
</div>
<hr>
<div class="paragraph">
<p><code><strong><em>Null code</em></strong></code></p>
</div>
Expand Down Expand Up @@ -946,7 +949,7 @@ <h4 id="_fail"><a class="link" href="#_fail">Fail</a></h4>
<div class="sect2">
<h3 id="_duplicate_email_check"><a class="link" href="#_duplicate_email_check">Duplicate Email Check</a></h3>
<div class="sect3">
<h4 id="_success_2"><a class="link" href="#_success_2">Success</a></h4>
<h4 id="_success_2"><a class="link" href="#_success_2"><code><strong><em>Success</em></strong></code></a></h4>
<div class="paragraph">
<p><strong>응답 필드</strong></p>
</div>
Expand Down Expand Up @@ -1001,9 +1004,10 @@ <h4 id="_success_2"><a class="link" href="#_success_2">Success</a></h4>
{"exists":false,"loginType":"EMAIL"}</code></pre>
</div>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="_fail_2"><a class="link" href="#_fail_2">Fail</a></h4>
<h4 id="_fail_2"><a class="link" href="#_fail_2"><code><strong><em>Fail</em></strong></code></a></h4>
<div class="paragraph">
<p><strong>응답 필드</strong></p>
</div>
Expand Down Expand Up @@ -1064,7 +1068,7 @@ <h4 id="_fail_2"><a class="link" href="#_fail_2">Fail</a></h4>
<div class="sect2">
<h3 id="_duplicate_nickname_check"><a class="link" href="#_duplicate_nickname_check">Duplicate Nickname Check</a></h3>
<div class="sect3">
<h4 id="_success_3"><a class="link" href="#_success_3">Success</a></h4>
<h4 id="_success_3"><a class="link" href="#_success_3"><code><strong><em>Success</em></strong></code></a></h4>
<div class="paragraph">
<p><strong>응답 필드</strong></p>
</div>
Expand Down Expand Up @@ -1120,7 +1124,7 @@ <h4 id="_success_3"><a class="link" href="#_success_3">Success</a></h4>
</div>
</div>
<div class="sect3">
<h4 id="_fail_3"><a class="link" href="#_fail_3">Fail</a></h4>
<h4 id="_fail_3"><a class="link" href="#_fail_3"><code><strong><em>Fail</em></strong></code></a></h4>
<div class="paragraph">
<p><strong>응답 필드</strong></p>
</div>
Expand Down Expand Up @@ -1180,7 +1184,7 @@ <h4 id="_fail_3"><a class="link" href="#_fail_3">Fail</a></h4>
<div class="sect2">
<h3 id="_signup"><a class="link" href="#_signup">Signup</a></h3>
<div class="sect3">
<h4 id="_success_4"><a class="link" href="#_success_4">Success</a></h4>
<h4 id="_success_4"><a class="link" href="#_success_4"><code><strong><em>Success</em></strong></code></a></h4>
<div class="paragraph">
<p><strong>요청 필드</strong></p>
</div>
Expand Down Expand Up @@ -1280,7 +1284,7 @@ <h4 id="_success_4"><a class="link" href="#_success_4">Success</a></h4>
<hr>
</div>
<div class="sect3">
<h4 id="_fail_4"><a class="link" href="#_fail_4">Fail</a></h4>
<h4 id="_fail_4"><a class="link" href="#_fail_4"><code><strong><em>Fail</em></strong></code></a></h4>
<div class="paragraph">
<p><code><strong><em>1. Short password</em></strong></code></p>
</div>
Expand Down Expand Up @@ -1385,6 +1389,7 @@ <h4 id="_fail_4"><a class="link" href="#_fail_4">Fail</a></h4>
{"errorCode":409,"message":"[password](은)는 size must be between 8 and 2147483647 입력된 값: [1234]"}</code></pre>
</div>
</div>
<hr>
<div class="paragraph">
<p><code><strong><em>2. Wrong email</em></strong></code></p>
</div>
Expand Down Expand Up @@ -1489,6 +1494,7 @@ <h4 id="_fail_4"><a class="link" href="#_fail_4">Fail</a></h4>
{"errorCode":409,"message":"[email](은)는 must be a well-formed email address 입력된 값: [email.com]"}</code></pre>
</div>
</div>
<hr>
<div class="paragraph">
<p><code><strong><em>3. Null password</em></strong></code></p>
</div>
Expand Down Expand Up @@ -1593,6 +1599,7 @@ <h4 id="_fail_4"><a class="link" href="#_fail_4">Fail</a></h4>
{"errorCode":409,"message":"[password](은)는 must not be null 입력된 값: [null]"}</code></pre>
</div>
</div>
<hr>
<div class="paragraph">
<p><code><strong><em>4. Null nickname</em></strong></code></p>
</div>
Expand Down Expand Up @@ -1697,6 +1704,7 @@ <h4 id="_fail_4"><a class="link" href="#_fail_4">Fail</a></h4>
{"errorCode":409,"message":"[nickName](은)는 must not be null 입력된 값: [null]"}</code></pre>
</div>
</div>
<hr>
<div class="paragraph">
<p><code><strong><em>5. Null username</em></strong></code></p>
</div>
Expand Down Expand Up @@ -1795,8 +1803,9 @@ <h4 id="_fail_4"><a class="link" href="#_fail_4">Fail</a></h4>
'Content-Type:application/json'</code></pre>
</div>
</div>
<hr>
<div class="paragraph">
<p><code><strong><em>7. Sign Up Fail - Null applicationPassword</em></strong></code></p>
<p><code><strong><em>6. Sign Up Fail - Null applicationPassword</em></strong></code></p>
</div>
<div class="paragraph">
<p><strong>요청 필드</strong></p>
Expand Down Expand Up @@ -1905,7 +1914,7 @@ <h4 id="_fail_4"><a class="link" href="#_fail_4">Fail</a></h4>
<div class="sect2">
<h3 id="_login"><a class="link" href="#_login">Login</a></h3>
<div class="sect3">
<h4 id="_success_5"><a class="link" href="#_success_5">Success</a></h4>
<h4 id="_success_5"><a class="link" href="#_success_5"><code><strong><em>Success</em></strong></code></a></h4>
<div class="paragraph">
<p><strong>요청 필드</strong></p>
</div>
Expand Down Expand Up @@ -2024,11 +2033,101 @@ <h4 id="_success_5"><a class="link" href="#_success_5">Success</a></h4>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="_fail_5"><a class="link" href="#_fail_5"><code><strong><em>Fail</em></strong></code></a></h4>
<div class="paragraph">
<p><strong>요청 필드</strong></p>
</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>email</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>password</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 class="paragraph">
<p><strong>응답 필드</strong></p>
</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>errorCode</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">발생한 에러 코드입니다. 이경우에는 409로 리턴됩니다.</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>Null</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">발생한 에러에 대한 설명입니다.</p></td>
</tr>
</tbody>
</table>
<div class="paragraph">
<p><strong>Example request</strong></p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code data-lang="http" class="language-http hljs">POST /auth/login HTTP/1.1
Content-Type: application/json
Content-Length: 57
Host: localhost:8080

{"email":"api_test_user@email.com","password":"12345678"}</code></pre>
</div>
</div>
<div class="paragraph">
<p><strong>Example response</strong></p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code data-lang="http" class="language-http hljs">HTTP/1.1 409 Conflict
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 32

{"errorCode":409,"message":null}</code></pre>
</div>
</div>
<hr>
</div>
</div>
<div class="sect2">
<h3 id="_oauth_signup"><a class="link" href="#_oauth_signup">Oauth Signup</a></h3>
<div class="sect3">
<h4 id="_success_6"><a class="link" href="#_success_6">Success</a></h4>
<h4 id="_success_6"><a class="link" href="#_success_6"><code><strong><em>Success</em></strong></code></a></h4>
<div class="paragraph">
<p><strong>요청 필드</strong></p>
</div>
Expand Down Expand Up @@ -2166,7 +2265,7 @@ <h4 id="_success_6"><a class="link" href="#_success_6">Success</a></h4>
<div class="sect2">
<h3 id="_token_reissue"><a class="link" href="#_token_reissue">Token Reissue</a></h3>
<div class="sect3">
<h4 id="_success_7"><a class="link" href="#_success_7">Success</a></h4>
<h4 id="_success_7"><a class="link" href="#_success_7"><code><strong><em>Success</em></strong></code></a></h4>
<div class="paragraph">
<p><strong>요청 필드</strong></p>
</div>
Expand Down Expand Up @@ -2253,9 +2352,10 @@ <h4 id="_success_7"><a class="link" href="#_success_7">Success</a></h4>
{"accessToken":"ACCESS_TOKEN","grantType":"Bearer","accessTokenExpiresIn":1000000}</code></pre>
</div>
</div>
<hr>
</div>
<div class="sect3">
<h4 id="_fail_5"><a class="link" href="#_fail_5">Fail</a></h4>
<h4 id="_fail_6"><a class="link" href="#_fail_6"><code><strong><em>Fail</em></strong></code></a></h4>
<div class="paragraph">
<p><strong>요청 필드</strong></p>
</div>
Expand Down Expand Up @@ -2346,7 +2446,7 @@ <h4 id="_fail_5"><a class="link" href="#_fail_5">Fail</a></h4>
<div id="footer">
<div id="footer-text">
Version 0.0.1-SNAPSHOT<br>
Last updated 2023-07-04 19:13:52 +0900
Last updated 2023-07-04 19:24:08 +0900
</div>
</div>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">
Expand Down

0 comments on commit 1102ef3

Please sign in to comment.