Skip to content

Commit

Permalink
docs: 누락된 문서 추가
Browse files Browse the repository at this point in the history
  • Loading branch information
@JJ503
JJ503 committed Dec 29, 2023
1 parent 39f0361 commit 272238f
Show file tree
Hide file tree
Showing 3 changed files with 184 additions and 1 deletion.
1 change: 1 addition & 0 deletions src/docs/asciidoc/friend.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ operation::friend-controller-test/친구_요청을_보낸_사용자_목록을_
==== 요청
operation::friend-controller-test/친구_요청을_받은_사용자_목록을_조회한다[snippets='http-request,request-headers']
==== 응답
operation::friend-controller-test/친구_요청을_받은_사용자_목록을_조회한다[snippets='http-response,response-fields']

=== 서로 친구인 사용자 목록 조회
==== 요청
Expand Down
91 changes: 91 additions & 0 deletions src/main/resources/static/docs/docs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1471,7 +1471,98 @@ <h5 id="_요청_9_request_headers"><a class="link" href="#_요청_9_request_head
</div>
<div class="sect3">
<h4 id="_응답_9"><a class="link" href="#_응답_9">응답</a></h4>
<div class="sect4">
<h5 id="_응답_9_http_response"><a class="link" href="#_응답_9_http_response">HTTP response</a></h5>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
Content-Type: application/json

{
"friends" : [ {
"id" : 1,
"friend" : {
"id" : 2,
"email" : "[email protected]",
"name" : "사용자1",
"color" : "#96b0e5",
"statusMessage" : "상태 메시지"
},
"isFriends" : false
}, {
"id" : 2,
"friend" : {
"id" : 3,
"email" : "[email protected]",
"name" : "사용자2",
"color" : "#96b0e5",
"statusMessage" : "상태 메시지"
},
"isFriends" : false
} ]
}</code></pre>
</div>
</div>
</div>
<div class="sect4">
<h5 id="_응답_9_response_fields"><a class="link" href="#_응답_9_response_fields">Response fields</a></h5>
<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>friends</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>friends.[].id</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>friends.[].friend.id</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>friends.[].friend.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>friends.[].friend.name</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>friends.[].friend.color</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>friends.[].friend.statusMessage</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>friends.[].isFriends</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>
</div>
<div class="sect2">
Expand Down
93 changes: 92 additions & 1 deletion src/main/resources/static/docs/friend.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,98 @@ <h5 id="_요청_3_request_headers">Request headers</h5>
</div>
<div class="sect3">
<h4 id="_응답_3">응답</h4>
<div class="sect4">
<h5 id="_응답_3_http_response">HTTP response</h5>
<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

{
"friends" : [ {
"id" : 1,
"friend" : {
"id" : 2,
"email" : "[email protected]",
"name" : "사용자1",
"color" : "#96b0e5",
"statusMessage" : "상태 메시지"
},
"isFriends" : false
}, {
"id" : 2,
"friend" : {
"id" : 3,
"email" : "[email protected]",
"name" : "사용자2",
"color" : "#96b0e5",
"statusMessage" : "상태 메시지"
},
"isFriends" : false
} ]
}</code></pre>
</div>
</div>
</div>
<div class="sect4">
<h5 id="_응답_3_response_fields">Response fields</h5>
<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>friends</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>friends.[].id</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>friends.[].friend.id</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>friends.[].friend.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>friends.[].friend.name</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>friends.[].friend.color</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>friends.[].friend.statusMessage</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>friends.[].isFriends</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>
</div>
<div class="sect2">
Expand Down Expand Up @@ -984,7 +1075,7 @@ <h5 id="_응답_6_http_response">HTTP response</h5>
<div id="footer">
<div id="footer-text">
Version 0.0.1-SNAPSHOT<br>
Last updated 2023-12-24 23:05:34 +0900
Last updated 2023-12-30 01:50:01 +0900
</div>
</div>
</body>
Expand Down

0 comments on commit 272238f

Please sign in to comment.