Skip to content

Commit

Permalink
docs: 허브 링크 묶음 목록 조회 api 문서화
Browse files Browse the repository at this point in the history
  • Loading branch information
@hseong3243
hseong3243 committed Feb 18, 2024
1 parent 811ced9 commit 55c48b4
Show file tree
Hide file tree
Showing 2 changed files with 154 additions and 21 deletions.
10 changes: 10 additions & 0 deletions src/docs/asciidoc/index.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,16 @@ operation::link-controller-test/create-hub-link[snippets='http-response,response

operation::link-controller-test/find-links[snippets='http-response,response-fields']

=== 허브 링크 묶음 목록 조회

==== request

operation::link-bundle-controller-test/find-hub-link-bundles[snippets='http-request,request-headers,path-parameters']

==== response

operation::link-bundle-controller-test/find-hub-link-bundles[snippets='http-response,response-fields']

== 허브

=== 허브 생성
Expand Down
165 changes: 144 additions & 21 deletions src/main/resources/static/docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -468,6 +468,7 @@ <h1>API 문서</h1>
<li><a href="#_링크_생성">링크 생성</a></li>
<li><a href="#_링크_목록_조회">링크 목록 조회</a></li>
<li><a href="#_허브_링크_생성">허브 링크 생성</a></li>
<li><a href="#_허브_링크_묶음_목록_조회">허브 링크 묶음 목록 조회</a></li>
</ul>
</li>
<li><a href="#_허브">허브</a>
Expand Down Expand Up @@ -706,7 +707,7 @@ <h5 id="_request_3_http_request"><a class="link" href="#_request_3_http_request"
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /api/link-bundles HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ0ZXN0IiwiaWF0IjoxNzA4MDkwNzc0LCJzdWIiOiIxIiwiZXhwIjoxNzA4MDk0Mzc0LCJyb2xlIjoiUk9MRV9VU0VSIn0.VhlHhySUpcDTp7n5FzwbQFa5e8qqX2ANyR1ZtD3gIbs
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ0ZXN0IiwiaWF0IjoxNzA4MjY1MDI1LCJzdWIiOiIxIiwiZXhwIjoxNzA4MjY4NjI1LCJyb2xlIjoiUk9MRV9VU0VSIn0.jZ4zWxq2NUNkY4APeYGzc2PX_JJqwmYESPChjvJaz4A
Content-Length: 57
Host: localhost:8080

Expand Down Expand Up @@ -822,7 +823,7 @@ <h5 id="_request_4_http_request"><a class="link" href="#_request_4_http_request"
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">GET /api/link-bundles HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ0ZXN0IiwiaWF0IjoxNzA4MDkwNzc0LCJzdWIiOiIxIiwiZXhwIjoxNzA4MDk0Mzc0LCJyb2xlIjoiUk9MRV9VU0VSIn0.VhlHhySUpcDTp7n5FzwbQFa5e8qqX2ANyR1ZtD3gIbs
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ0ZXN0IiwiaWF0IjoxNzA4MjY1MDI1LCJzdWIiOiIxIiwiZXhwIjoxNzA4MjY4NjI1LCJyb2xlIjoiUk9MRV9VU0VSIn0.jZ4zWxq2NUNkY4APeYGzc2PX_JJqwmYESPChjvJaz4A
Host: localhost:8080</code></pre>
</div>
</div>
Expand Down Expand Up @@ -927,7 +928,7 @@ <h5 id="_request_5_http_request"><a class="link" href="#_request_5_http_request"
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /api/hubs/1/link-bundles HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ0ZXN0IiwiaWF0IjoxNzA4MDkwNzc0LCJzdWIiOiIxIiwiZXhwIjoxNzA4MDk0Mzc0LCJyb2xlIjoiUk9MRV9VU0VSIn0.VhlHhySUpcDTp7n5FzwbQFa5e8qqX2ANyR1ZtD3gIbs
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ0ZXN0IiwiaWF0IjoxNzA4MjY1MDI1LCJzdWIiOiIxIiwiZXhwIjoxNzA4MjY4NjI1LCJyb2xlIjoiUk9MRV9VU0VSIn0.jZ4zWxq2NUNkY4APeYGzc2PX_JJqwmYESPChjvJaz4A
Content-Length: 53
Host: localhost:8080

Expand Down Expand Up @@ -1071,7 +1072,7 @@ <h5 id="_request_6_http_request"><a class="link" href="#_request_6_http_request"
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /api/links HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ0ZXN0IiwiaWF0IjoxNzA4MDkwNzc0LCJzdWIiOiIxIiwiZXhwIjoxNzA4MDk0Mzc0LCJyb2xlIjoiUk9MRV9VU0VSIn0.VhlHhySUpcDTp7n5FzwbQFa5e8qqX2ANyR1ZtD3gIbs
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ0ZXN0IiwiaWF0IjoxNzA4MjY1MDI1LCJzdWIiOiIxIiwiZXhwIjoxNzA4MjY4NjI1LCJyb2xlIjoiUk9MRV9VU0VSIn0.jZ4zWxq2NUNkY4APeYGzc2PX_JJqwmYESPChjvJaz4A
Content-Length: 100
Host: localhost:8080

Expand Down Expand Up @@ -1193,7 +1194,7 @@ <h5 id="_request_7_http_request"><a class="link" href="#_request_7_http_request"
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">GET /api/links?linkBundleId=1&amp;page=0&amp;size=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ0ZXN0IiwiaWF0IjoxNzA4MDkwNzc0LCJzdWIiOiIxIiwiZXhwIjoxNzA4MDk0Mzc0LCJyb2xlIjoiUk9MRV9VU0VSIn0.VhlHhySUpcDTp7n5FzwbQFa5e8qqX2ANyR1ZtD3gIbs
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ0ZXN0IiwiaWF0IjoxNzA4MjY1MDI1LCJzdWIiOiIxIiwiZXhwIjoxNzA4MjY4NjI1LCJyb2xlIjoiUk9MRV9VU0VSIn0.jZ4zWxq2NUNkY4APeYGzc2PX_JJqwmYESPChjvJaz4A
Host: localhost:8080</code></pre>
</div>
</div>
Expand Down Expand Up @@ -1260,7 +1261,7 @@ <h5 id="_request_8_http_request"><a class="link" href="#_request_8_http_request"
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /api/hubs/1/links HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ0ZXN0IiwiaWF0IjoxNzA4MDkwNzc0LCJzdWIiOiIxIiwiZXhwIjoxNzA4MDk0Mzc0LCJyb2xlIjoiUk9MRV9VU0VSIn0.VhlHhySUpcDTp7n5FzwbQFa5e8qqX2ANyR1ZtD3gIbs
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ0ZXN0IiwiaWF0IjoxNzA4MjY1MDI1LCJzdWIiOiIxIiwiZXhwIjoxNzA4MjY4NjI1LCJyb2xlIjoiUk9MRV9VU0VSIn0.jZ4zWxq2NUNkY4APeYGzc2PX_JJqwmYESPChjvJaz4A
Content-Length: 69
Host: localhost:8080

Expand Down Expand Up @@ -1470,6 +1471,128 @@ <h5 id="_response_8_response_fields"><a class="link" href="#_response_8_response
</div>
</div>
</div>
<div class="sect2">
<h3 id="_허브_링크_묶음_목록_조회"><a class="link" href="#_허브_링크_묶음_목록_조회">허브 링크 묶음 목록 조회</a></h3>
<div class="sect3">
<h4 id="_request_9"><a class="link" href="#_request_9">request</a></h4>
<div class="sect4">
<h5 id="_request_9_http_request"><a class="link" href="#_request_9_http_request">HTTP request</a></h5>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">GET /api/hubs/1/link-bundles HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ0ZXN0IiwiaWF0IjoxNzA4MjY1MDI1LCJzdWIiOiIxIiwiZXhwIjoxNzA4MjY4NjI1LCJyb2xlIjoiUk9MRV9VU0VSIn0.jZ4zWxq2NUNkY4APeYGzc2PX_JJqwmYESPChjvJaz4A
Host: localhost:8080</code></pre>
</div>
</div>
</div>
<div class="sect4">
<h5 id="_request_9_request_headers"><a class="link" href="#_request_9_request_headers">Request headers</a></h5>
<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">액세스 토큰</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect4">
<h5 id="_request_9_path_parameters"><a class="link" href="#_request_9_path_parameters">Path parameters</a></h5>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 1. /api/hubs/{hubId}/link-bundles</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>hubId</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">허브 ID</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect3">
<h4 id="_response_9"><a class="link" href="#_response_9">response</a></h4>
<div class="sect4">
<h5 id="_response_9_http_response"><a class="link" href="#_response_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
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json;charset=UTF-8
Content-Length: 109

{
"linkBundles" : [ {
"linkBundleId" : 1,
"description" : "기본",
"isDefault" : false
} ]
}</code></pre>
</div>
</div>
</div>
<div class="sect4">
<h5 id="_response_9_response_fields"><a class="link" href="#_response_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>linkBundles</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>linkBundles[].linkBundleId</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>linkBundles[].description</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>linkBundles[].isDefault</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>
</div>
<div class="sect1">
Expand All @@ -1478,14 +1601,14 @@ <h2 id="_허브"><a class="link" href="#_허브">허브</a></h2>
<div class="sect2">
<h3 id="_허브_생성"><a class="link" href="#_허브_생성">허브 생성</a></h3>
<div class="sect3">
<h4 id="_request_9"><a class="link" href="#_request_9">request</a></h4>
<h4 id="_request_10"><a class="link" href="#_request_10">request</a></h4>
<div class="sect4">
<h5 id="_request_9_http_request"><a class="link" href="#_request_9_http_request">HTTP request</a></h5>
<h5 id="_request_10_http_request"><a class="link" href="#_request_10_http_request">HTTP request</a></h5>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">POST /api/hubs HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ0ZXN0IiwiaWF0IjoxNzA4MDkwNzc0LCJzdWIiOiIxIiwiZXhwIjoxNzA4MDk0Mzc0LCJyb2xlIjoiUk9MRV9VU0VSIn0.VhlHhySUpcDTp7n5FzwbQFa5e8qqX2ANyR1ZtD3gIbs
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ0ZXN0IiwiaWF0IjoxNzA4MjY1MDI1LCJzdWIiOiIxIiwiZXhwIjoxNzA4MjY4NjI1LCJyb2xlIjoiUk9MRV9VU0VSIn0.jZ4zWxq2NUNkY4APeYGzc2PX_JJqwmYESPChjvJaz4A
Content-Length: 88
Host: localhost:8080

Expand All @@ -1498,7 +1621,7 @@ <h5 id="_request_9_http_request"><a class="link" href="#_request_9_http_request"
</div>
</div>
<div class="sect4">
<h5 id="_request_9_request_headers"><a class="link" href="#_request_9_request_headers">Request headers</a></h5>
<h5 id="_request_10_request_headers"><a class="link" href="#_request_10_request_headers">Request headers</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 50%;">
Expand All @@ -1519,7 +1642,7 @@ <h5 id="_request_9_request_headers"><a class="link" href="#_request_9_request_he
</table>
</div>
<div class="sect4">
<h5 id="_request_9_request_fields"><a class="link" href="#_request_9_request_fields">Request fields</a></h5>
<h5 id="_request_10_request_fields"><a class="link" href="#_request_10_request_fields">Request fields</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
Expand Down Expand Up @@ -1554,9 +1677,9 @@ <h5 id="_request_9_request_fields"><a class="link" href="#_request_9_request_fie
</div>
</div>
<div class="sect3">
<h4 id="_response_9"><a class="link" href="#_response_9">response</a></h4>
<h4 id="_response_10"><a class="link" href="#_response_10">response</a></h4>
<div class="sect4">
<h5 id="_response_9_http_response"><a class="link" href="#_response_9_http_response">HTTP response</a></h5>
<h5 id="_response_10_http_response"><a class="link" href="#_response_10_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 201 Created
Expand All @@ -1573,7 +1696,7 @@ <h5 id="_response_9_http_response"><a class="link" href="#_response_9_http_respo
</div>
</div>
<div class="sect4">
<h5 id="_response_9_response_fields"><a class="link" href="#_response_9_response_fields">Response fields</a></h5>
<h5 id="_response_10_response_fields"><a class="link" href="#_response_10_response_fields">Response fields</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
Expand Down Expand Up @@ -1601,9 +1724,9 @@ <h5 id="_response_9_response_fields"><a class="link" href="#_response_9_response
<div class="sect2">
<h3 id="_허브_목록_조회"><a class="link" href="#_허브_목록_조회">허브 목록 조회</a></h3>
<div class="sect3">
<h4 id="_request_10"><a class="link" href="#_request_10">request</a></h4>
<h4 id="_request_11"><a class="link" href="#_request_11">request</a></h4>
<div class="sect4">
<h5 id="_request_10_http_request"><a class="link" href="#_request_10_http_request">HTTP request</a></h5>
<h5 id="_request_11_http_request"><a class="link" href="#_request_11_http_request">HTTP request</a></h5>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">GET /api/hubs?page=0&amp;size=0 HTTP/1.1
Expand All @@ -1612,7 +1735,7 @@ <h5 id="_request_10_http_request"><a class="link" href="#_request_10_http_reques
</div>
</div>
<div class="sect4">
<h5 id="_request_10_path_parameters"><a class="link" href="#_request_10_path_parameters">Path parameters</a></h5>
<h5 id="_request_11_path_parameters"><a class="link" href="#_request_11_path_parameters">Path parameters</a></h5>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 1. /api/hubs</caption>
<colgroup>
Expand All @@ -1639,9 +1762,9 @@ <h5 id="_request_10_path_parameters"><a class="link" href="#_request_10_path_par
</div>
</div>
<div class="sect3">
<h4 id="_response_10"><a class="link" href="#_response_10">response</a></h4>
<h4 id="_response_11"><a class="link" href="#_response_11">response</a></h4>
<div class="sect4">
<h5 id="_response_10_http_response"><a class="link" href="#_response_10_http_response">HTTP response</a></h5>
<h5 id="_response_11_http_response"><a class="link" href="#_response_11_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
Expand All @@ -1666,7 +1789,7 @@ <h5 id="_response_10_http_response"><a class="link" href="#_response_10_http_res
</div>
</div>
<div class="sect4">
<h5 id="_response_10_response_fields"><a class="link" href="#_response_10_response_fields">Response fields</a></h5>
<h5 id="_response_11_response_fields"><a class="link" href="#_response_11_response_fields">Response fields</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
Expand Down Expand Up @@ -1732,7 +1855,7 @@ <h5 id="_response_10_response_fields"><a class="link" href="#_response_10_respon
<div id="footer">
<div id="footer-text">
Version 0.0.1-SNAPSHOT<br>
Last updated 2024-02-16 22:39:23 +0900
Last updated 2024-02-18 23:03:33 +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 55c48b4

Please sign in to comment.