Skip to content

Commit

Permalink
[DOCS] 문서화 반영 #218
Browse files Browse the repository at this point in the history
  • Loading branch information
@Jin409
Jin409 committed Sep 25, 2024
1 parent 22c7985 commit c4b5c06
Showing 1 changed file with 154 additions and 19 deletions.
173 changes: 154 additions & 19 deletions src/main/resources/static/docs/api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -509,6 +509,7 @@ <h1>훕치치 서버 API 문서</h1>
<li><a href="#_득점_타임라인_생성">득점 타임라인 생성</a></li>
<li><a href="#_교체_타임라인_생성">교체 타임라인 생성</a></li>
<li><a href="#_게임_진행_타임라인_생성">게임 진행 타임라인 생성</a></li>
<li><a href="#_승부차기_타임라인_생성">승부차기 타임라인 생성</a></li>
<li><a href="#_게임의_타임라인_조회">게임의 타임라인 조회</a></li>
<li><a href="#_타임라인_삭제">타임라인 삭제</a></li>
</ul>
Expand Down Expand Up @@ -881,6 +882,39 @@ <h4 id="_신고된_리그의_응원톡_전체_조회_response_fields"><a class="
</table>
</div>
</div>
<div class="sect2">
<h3 id="_응원톡_관리_화면에서의_응원톡_전체_조회"><a class="link" href="#_응원톡_관리_화면에서의_응원톡_전체_조회">응원톡 관리 화면에서의 응원톡 전체 조회</a></h3>
<div class="sect3">
<h4 id="_응원톡_관리_화면에서의_응원톡_전체_조회_http_request"><a class="link" href="#_응원톡_관리_화면에서의_응원톡_전체_조회_http_request">HTTP request</a></h4>
<div class="paragraph">
<p>Snippet http-request not found for operation::cheer-talk-query-controller-test/리그의_차단되지_않은_응원톡을_조회한다</p>
</div>
</div>
<div class="sect3">
<h4 id="_응원톡_관리_화면에서의_응원톡_전체_조회_query_parameters"><a class="link" href="#_응원톡_관리_화면에서의_응원톡_전체_조회_query_parameters">Query parameters</a></h4>
<div class="paragraph">
<p>Snippet query-parameters not found for operation::cheer-talk-query-controller-test/리그의_차단되지_않은_응원톡을_조회한다</p>
</div>
</div>
<div class="sect3">
<h4 id="_응원톡_관리_화면에서의_응원톡_전체_조회_path_parameters"><a class="link" href="#_응원톡_관리_화면에서의_응원톡_전체_조회_path_parameters">Path parameters</a></h4>
<div class="paragraph">
<p>Snippet path-parameters not found for operation::cheer-talk-query-controller-test/리그의_차단되지_않은_응원톡을_조회한다</p>
</div>
</div>
<div class="sect3">
<h4 id="_응원톡_관리_화면에서의_응원톡_전체_조회_http_response"><a class="link" href="#_응원톡_관리_화면에서의_응원톡_전체_조회_http_response">HTTP response</a></h4>
<div class="paragraph">
<p>Snippet http-response not found for operation::cheer-talk-query-controller-test/리그의_차단되지_않은_응원톡을_조회한다</p>
</div>
</div>
<div class="sect3">
<h4 id="_응원톡_관리_화면에서의_응원톡_전체_조회_response_fields"><a class="link" href="#_응원톡_관리_화면에서의_응원톡_전체_조회_response_fields">Response fields</a></h4>
<div class="paragraph">
<p>Snippet response-fields not found for operation::cheer-talk-query-controller-test/리그의_차단되지_않은_응원톡을_조회한다</p>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
Expand Down Expand Up @@ -1766,7 +1800,7 @@ <h4 id="_게임_등록_http_request"><a class="link" href="#_게임_등록_http_
"round" : "16강",
"quarter" : "경기전",
"state" : "SCHEDULED",
"startTime" : "2024-09-23T15:31:00.596678",
"startTime" : "2024-09-25T10:50:31.159077",
"idOfTeam1" : 1,
"idOfTeam2" : 2,
"videoId" : "videoId"
Expand Down Expand Up @@ -1826,7 +1860,7 @@ <h4 id="_게임_수정_http_request"><a class="link" href="#_게임_수정_http_
"round" : "16강",
"quarter" : "전반전",
"state" : "PLAYING",
"startTime" : "2024-09-23T15:31:00.616265",
"startTime" : "2024-09-25T10:50:31.197746",
"videoId" : "videoId"
}</code></pre>
</div>
Expand Down Expand Up @@ -2086,15 +2120,15 @@ <h4 id="_리그_생성_http_request"><a class="link" href="#_리그_생성_http_
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /leagues HTTP/1.1
Content-Type: application/json
Content-Length: 149
Content-Length: 150
Host: www.api.hufstreaming.site
Cookie: HCC_SES=temp-cookie

{
"name" : "우물정 제기차기 대회",
"maxRound" : 4,
"startAt" : "2024-09-23T15:31:01.385003",
"endAt" : "2024-09-23T15:31:01.38501"
"startAt" : "2024-09-25T10:50:31.897139",
"endAt" : "2024-09-25T10:50:31.897146"
}</code></pre>
</div>
</div>
Expand Down Expand Up @@ -2158,14 +2192,14 @@ <h4 id="_리그_수정_http_request"><a class="link" href="#_리그_수정_http_
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">PUT /leagues/5124 HTTP/1.1
Content-Type: application/json
Content-Length: 165
Content-Length: 166
Host: www.api.hufstreaming.site
Cookie: HCC_SES=temp-cookie

{
"name" : "훕치치배 망고 빨리먹기 대회",
"startAt" : "2024-09-23T15:31:01.43312",
"endAt" : "2024-09-23T15:31:01.433126",
"startAt" : "2024-09-25T10:50:31.945523",
"endAt" : "2024-09-25T10:50:31.945531",
"maxRound" : "16강"
}</code></pre>
</div>
Expand Down Expand Up @@ -3037,20 +3071,20 @@ <h4 id="_매니저가_생성한_리그_전체_조회홈_화면_http_response"><a
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 631
Content-Length: 633

[ {
"id" : 1,
"name" : "삼건물 대회",
"state" : "진행 중",
"sizeOfLeagueTeams" : 2,
"maxRound" : "16강",
"startAt" : "2024-09-23T15:31:10.35592",
"endAt" : "2024-09-23T15:31:10.35592",
"startAt" : "2024-09-25T10:50:40.970863",
"endAt" : "2024-09-25T10:50:40.970863",
"inProgressGames" : [ {
"id" : 1,
"state" : "PLAYING",
"startTime" : "2024-09-23T15:31:10.355908",
"startTime" : "2024-09-25T10:50:40.970846",
"gameTeams" : [ {
"gameTeamId" : 1,
"gameTeamName" : "경영 야생마",
Expand Down Expand Up @@ -3189,24 +3223,24 @@ <h4 id="_매니저가_생성한_리그_전체_조회대회_관리_화면_http_re
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 436
Content-Length: 437

[ {
"id" : 1,
"name" : "삼건물 대회",
"leagueProgress" : "진행 중",
"sizeOfLeagueTeams" : 2,
"maxRound" : "16강",
"startAt" : "2024-09-23T15:31:10.47193",
"endAt" : "2024-09-23T15:31:10.471935"
"startAt" : "2024-09-25T10:50:41.130852",
"endAt" : "2024-09-25T10:50:41.130857"
}, {
"id" : 2,
"name" : "탁구 대회",
"leagueProgress" : "시작 전",
"sizeOfLeagueTeams" : 2,
"maxRound" : "16강",
"startAt" : "2024-09-23T15:31:10.471949",
"endAt" : "2024-09-23T15:31:10.471949"
"startAt" : "2024-09-25T10:50:41.130873",
"endAt" : "2024-09-25T10:50:41.130874"
} ]</code></pre>
</div>
</div>
Expand Down Expand Up @@ -3982,6 +4016,107 @@ <h4 id="_게임_진행_타임라인_생성_http_response"><a class="link" href="
</div>
</div>
<div class="sect2">
<h3 id="_승부차기_타임라인_생성"><a class="link" href="#_승부차기_타임라인_생성">승부차기 타임라인 생성</a></h3>
<div class="sect3">
<h4 id="_승부차기_타임라인_생성_http_request"><a class="link" href="#_승부차기_타임라인_생성_http_request">HTTP request</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /games/1/timelines/pk HTTP/1.1
Content-Type: application/json
Content-Length: 110
Host: www.api.hufstreaming.site
Cookie: HCC_SES=temp-cookie

{
"recordedQuarterId" : 2,
"recordedAt" : 10,
"gameTeamId" : 1,
"scorerId" : 1,
"isSuccess" : true
}</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="_승부차기_타임라인_생성_path_parameters"><a class="link" href="#_승부차기_타임라인_생성_path_parameters">Path parameters</a></h4>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 1. /games/{gameId}/timelines/pk</caption>
<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>gameId</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">경기의 ID</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_승부차기_타임라인_생성_request_fields"><a class="link" href="#_승부차기_타임라인_생성_request_fields">Request fields</a></h4>
<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>gameTeamId</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">경기 팀의 Id</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>recordedQuarterId</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">쿼터 Id</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>scorerId</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">승부차기 득점 선수 Id</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>recordedAt</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>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>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="_승부차기_타임라인_생성_http_response"><a class="link" href="#_승부차기_타임라인_생성_http_response">HTTP response</a></h4>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location:</code></pre>
</div>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_게임의_타임라인_조회"><a class="link" href="#_게임의_타임라인_조회">게임의 타임라인 조회</a></h3>
<div class="sect3">
<h4 id="_게임의_타임라인_조회_http_request"><a class="link" href="#_게임의_타임라인_조회_http_request">HTTP request</a></h4>
Expand Down Expand Up @@ -4388,7 +4523,7 @@ <h4 id="_사용자_로그인_http_response"><a class="link" href="#_사용자_
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Set-Cookie: HCC_SES=testAccessToken; Path=/; Max-Age=604800; Expires=Mon, 30 Sep 2024 06:30:54 GMT; Secure; HttpOnly; SameSite=Strict</code></pre>
Set-Cookie: HCC_SES=testAccessToken; Path=/; Max-Age=604800; Expires=Wed, 2 Oct 2024 01:50:18 GMT; Secure; HttpOnly; SameSite=Strict</code></pre>
</div>
</div>
</div>
Expand Down Expand Up @@ -4462,7 +4597,7 @@ <h4 id="_사용자_정보_조회_response_fields"><a class="link" href="#_사용
<div id="footer">
<div id="footer-text">
Version 0.0.1-SNAPSHOT<br>
Last updated 2024-09-23 15:29:54 +0900
Last updated 2024-09-25 10:46:55 +0900
</div>
</div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>
Expand Down

0 comments on commit c4b5c06

Please sign in to comment.