Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

문서 업데이트 #345

Merged
merged 1 commit into from
Dec 17, 2023
Merged

문서 업데이트 #345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions src/docs/asciidoc/user.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,30 @@ include::{snippets}/update-user/http-request.adoc[]
===== Response
include::{snippets}/update-user/http-response.adoc[]

*회원탈퇴 시, 사용되는 enum*

|===
|enum 값|Description

|ROW_USE
|이용빈도 낮음

|RE_JOIN
|재가입

|INSUFFICIENT_CONTENT
|콘텐츠 및 정보 부족

|PERSONAL_PROTECTION
|개인 정보 보호

|ETC
|기타

|===

위의 표에 나와 있는 description을 사용자가 선택하게 됩니다. 그 description을 그대로 복붙해서 요청 body에 넣어주시면 됩니다.

=== 13. 유저 탈퇴
===== Request
include::{snippets}/withdrawal/http-request.adoc[]
Expand Down
90 changes: 45 additions & 45 deletions src/main/resources/static/docs/board.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,7 @@ <h5 id="_request">Request</h5>
<div class="content">
<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /api/v1/boards HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0X2pob3VzZV9jb20iLCJleHAiOjE3MDI2NTE0MjUsImF1dGgiOiJVU0VSIiwidHlwZSI6Ik5PTkUifQ.D-BDiHaZKjSbMX9W0AWjguc5nGajmnnoSqkLQuVTa8E9vhEVHx-Ka8Zr6WNhtr2_6WKnUfx05cCMaJQIu4ZKvQ
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0X2pob3VzZV9jb20iLCJleHAiOjE3MDI3ODg1MjAsImF1dGgiOiJVU0VSIiwidHlwZSI6Ik5PTkUifQ.ZuMFHTTspFVatSst53X3vn4fzlhtwvgEtpzzyGPRdN2-SEmbQ48gYFatmEMRi74HcRPLnFM_UBsLSvn85KpA-w
Accept: application/json
Content-Length: 316
Host: localhost:8080
Expand Down Expand Up @@ -491,7 +491,7 @@ <h4 id="_response">Response</h4>
{
"code" : "SUCCESS",
"message" : "성공",
"data" : 1310
"data" : 1387
}</code></pre>
</div>
</div>
Expand All @@ -504,7 +504,7 @@ <h5 id="_request_2">Request</h5>
<div class="content">
<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /api/v1/boards HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0X2pob3VzZV9jb20iLCJleHAiOjE3MDI2NTE0MjUsImF1dGgiOiJVU0VSIiwidHlwZSI6Ik5PTkUifQ.D-BDiHaZKjSbMX9W0AWjguc5nGajmnnoSqkLQuVTa8E9vhEVHx-Ka8Zr6WNhtr2_6WKnUfx05cCMaJQIu4ZKvQ
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0X2pob3VzZV9jb20iLCJleHAiOjE3MDI3ODg1MjAsImF1dGgiOiJVU0VSIiwidHlwZSI6Ik5PTkUifQ.ZuMFHTTspFVatSst53X3vn4fzlhtwvgEtpzzyGPRdN2-SEmbQ48gYFatmEMRi74HcRPLnFM_UBsLSvn85KpA-w
Accept: application/json
Content-Length: 312
Host: localhost:8080
Expand Down Expand Up @@ -534,7 +534,7 @@ <h5 id="_response_2">Response</h5>
{
"code" : "SUCCESS",
"message" : "성공",
"data" : 1308
"data" : 1385
}</code></pre>
</div>
</div>
Expand All @@ -548,7 +548,7 @@ <h5 id="_request_3">Request</h5>
<div class="content">
<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /api/v1/boards HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0X2pob3VzZV9jb20iLCJleHAiOjE3MDI2NTE0MjQsImF1dGgiOiJVU0VSIiwidHlwZSI6Ik5PTkUifQ.o8TOTxpTHAa4UQQIMZz61KOw5j1r-VXEjKDGO1lzWLHABuVc59GLCnJEZXzB1kx8z5bTddPVtKYEvjDkvyuFog
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0X2pob3VzZV9jb20iLCJleHAiOjE3MDI3ODg1MTksImF1dGgiOiJVU0VSIiwidHlwZSI6Ik5PTkUifQ.cUi9Vf_a2MVTGLzyMTM-AD8sJGG8MJisS7QRHrIDyACy7P1CHkvOmfeqUrbYDs2I-PdME2XJRTM2NHpZdc7e2Q
Accept: application/json
Content-Length: 317
Host: localhost:8080
Expand Down Expand Up @@ -578,7 +578,7 @@ <h5 id="_response_3">Response</h5>
{
"code" : "SUCCESS",
"message" : "성공",
"data" : 1301
"data" : 1378
}</code></pre>
</div>
</div>
Expand Down Expand Up @@ -623,12 +623,12 @@ <h5 id="_response_4">Response</h5>
"code" : "SUCCESS",
"message" : "성공",
"data" : [ {
"boardId" : 1298,
"boardId" : 1375,
"title" : "짱구는 못말려",
"code" : "&lt;body&gt; &lt;div&gt; &lt;h2&gt;짱구는 못말려&lt;/h2&gt; &lt;/div&gt; &lt;div&gt; &lt;i&gt;철수&lt;/i&gt;야 나랑 놀자 &lt;/div&gt; &lt;/body&gt;",
"oneLineContent" : "짱구는 못말려철수야 나랑 놀자",
"nickName" : "테스트유저1",
"createdAt" : "2023-12-15T14:13:44.571+00:00",
"createdAt" : "2023-12-17T04:18:39.576+00:00",
"imageUrl" : "img001",
"commentCount" : 1,
"category" : "TREND",
Expand Down Expand Up @@ -682,12 +682,12 @@ <h5 id="_response_5">Response</h5>
"message" : "성공",
"data" : {
"content" : [ {
"boardId" : 1302,
"boardId" : 1379,
"title" : "짱구는 못말려",
"code" : "&lt;body&gt; &lt;div&gt; &lt;h2&gt;짱구는 못말려&lt;/h2&gt; &lt;/div&gt; &lt;div&gt; &lt;i&gt;철수&lt;/i&gt;야 나랑 놀자 &lt;/div&gt; &lt;/body&gt;",
"oneLineContent" : "짱구는 못말려철수야 나랑 놀자",
"nickName" : "테스트유저1",
"createdAt" : "2023-12-15T14:13:44.940+00:00",
"createdAt" : "2023-12-17T04:18:39.986+00:00",
"imageUrl" : "img001",
"commentCount" : 1,
"category" : "TREND",
Expand All @@ -702,8 +702,8 @@ <h5 id="_response_5">Response</h5>
"number" : 0,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
"unsorted" : true,
"sorted" : false
},
"numberOfElements" : 1,
"empty" : false
Expand All @@ -719,7 +719,7 @@ <h4 id="_6_게시글_상세_조회">6. 게시글 상세 조회</h4>
<h5 id="_request_6">Request</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/v1/boards/1303 HTTP/1.1
<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/v1/boards/1380 HTTP/1.1
Accept: application/json
Host: localhost:8080</code></pre>
</div>
Expand All @@ -740,21 +740,21 @@ <h5 id="_response_6">Response</h5>
"code" : "SUCCESS",
"message" : "성공",
"data" : {
"boardId" : 1303,
"boardId" : 1380,
"title" : "짱구는 못말려",
"code" : "&lt;body&gt; &lt;div&gt; &lt;h2&gt;짱구는 못말려&lt;/h2&gt; &lt;/div&gt; &lt;div&gt; &lt;i&gt;철수&lt;/i&gt;야 나랑 놀자 &lt;/div&gt; &lt;/body&gt;",
"nickName" : "테스트유저1",
"createdAt" : "2023-12-15T14:13:45.056+00:00",
"createdAt" : "2023-12-17T04:18:40.083+00:00",
"imageUrls" : [ "img001" ],
"loveCount" : 0,
"category" : "TREND",
"prefixCategory" : "INTRO",
"commentCount" : 1,
"comments" : [ {
"commentId" : 31759,
"commentId" : 33728,
"nickName" : "테스트유저1",
"content" : "댓글이란다.",
"createdAt" : "2023-12-15T14:13:45.059+00:00"
"createdAt" : "2023-12-17T04:18:40.086+00:00"
} ]
}
}</code></pre>
Expand All @@ -768,9 +768,9 @@ <h4 id="_7_게시글_수정">7. 게시글 수정</h4>
<h5 id="_request_7">Request</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /api/v1/boards/1304 HTTP/1.1
<pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /api/v1/boards/1381 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0X2pob3VzZV9jb20iLCJleHAiOjE3MDI2NTE0MjUsImF1dGgiOiJVU0VSIiwidHlwZSI6Ik5PTkUifQ.D-BDiHaZKjSbMX9W0AWjguc5nGajmnnoSqkLQuVTa8E9vhEVHx-Ka8Zr6WNhtr2_6WKnUfx05cCMaJQIu4ZKvQ
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0X2pob3VzZV9jb20iLCJleHAiOjE3MDI3ODg1MjAsImF1dGgiOiJVU0VSIiwidHlwZSI6Ik5PTkUifQ.ZuMFHTTspFVatSst53X3vn4fzlhtwvgEtpzzyGPRdN2-SEmbQ48gYFatmEMRi74HcRPLnFM_UBsLSvn85KpA-w
Accept: application/json
Content-Length: 255
Host: localhost:8080
Expand Down Expand Up @@ -800,7 +800,7 @@ <h5 id="_response_7">Response</h5>
{
"code" : "SUCCESS",
"message" : "성공",
"data" : 1304
"data" : 1381
}</code></pre>
</div>
</div>
Expand All @@ -812,8 +812,8 @@ <h4 id="_8_게시글_삭제">8. 게시글 삭제</h4>
<h5 id="_request_8">Request</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/v1/boards/1299 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0X2pob3VzZV9jb20iLCJleHAiOjE3MDI2NTE0MjQsImF1dGgiOiJVU0VSIiwidHlwZSI6Ik5PTkUifQ.o8TOTxpTHAa4UQQIMZz61KOw5j1r-VXEjKDGO1lzWLHABuVc59GLCnJEZXzB1kx8z5bTddPVtKYEvjDkvyuFog
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/v1/boards/1376 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0X2pob3VzZV9jb20iLCJleHAiOjE3MDI3ODg1MTksImF1dGgiOiJVU0VSIiwidHlwZSI6Ik5PTkUifQ.cUi9Vf_a2MVTGLzyMTM-AD8sJGG8MJisS7QRHrIDyACy7P1CHkvOmfeqUrbYDs2I-PdME2XJRTM2NHpZdc7e2Q
Host: localhost:8080</code></pre>
</div>
</div>
Expand Down Expand Up @@ -885,7 +885,7 @@ <h5 id="_request_10">Request</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/v1/boards/my?page=0 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0X2pob3VzZV9jb20iLCJleHAiOjE3MDI2NTE0MjQsImF1dGgiOiJVU0VSIiwidHlwZSI6Ik5PTkUifQ.o8TOTxpTHAa4UQQIMZz61KOw5j1r-VXEjKDGO1lzWLHABuVc59GLCnJEZXzB1kx8z5bTddPVtKYEvjDkvyuFog
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0X2pob3VzZV9jb20iLCJleHAiOjE3MDI3ODg1MTksImF1dGgiOiJVU0VSIiwidHlwZSI6Ik5PTkUifQ.cUi9Vf_a2MVTGLzyMTM-AD8sJGG8MJisS7QRHrIDyACy7P1CHkvOmfeqUrbYDs2I-PdME2XJRTM2NHpZdc7e2Q
Host: localhost:8080</code></pre>
</div>
</div>
Expand All @@ -906,19 +906,19 @@ <h5 id="_response_10">Response</h5>
"message" : "성공",
"data" : {
"content" : [ {
"boardId" : 1297,
"boardId" : 1374,
"title" : "짱구는 못말려",
"oneLineContent" : "짱구는 못말려철수야 나랑 놀자",
"createdAt" : "2023-12-15T14:13:44.235+00:00",
"createdAt" : "2023-12-17T04:18:39.160+00:00",
"imageUrl" : "img001",
"category" : "TREND",
"prefixCategory" : "INTRO",
"commentCnt" : 0
}, {
"boardId" : 1296,
"boardId" : 1373,
"title" : "짱구는 못말려",
"oneLineContent" : "짱구는 못말려철수야 나랑 놀자",
"createdAt" : "2023-12-15T14:13:44.036+00:00",
"createdAt" : "2023-12-17T04:18:38.917+00:00",
"imageUrl" : "img001",
"category" : "TREND",
"prefixCategory" : "INTRO",
Expand All @@ -932,8 +932,8 @@ <h5 id="_response_10">Response</h5>
"number" : 0,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
"unsorted" : true,
"sorted" : false
},
"numberOfElements" : 2,
"empty" : false
Expand All @@ -950,7 +950,7 @@ <h5 id="_request_11">Request</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/v1/boards/my/comment?page=0 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0X2pob3VzZV9jb20iLCJleHAiOjE3MDI2NTE0MjUsImF1dGgiOiJVU0VSIiwidHlwZSI6Ik5PTkUifQ.D-BDiHaZKjSbMX9W0AWjguc5nGajmnnoSqkLQuVTa8E9vhEVHx-Ka8Zr6WNhtr2_6WKnUfx05cCMaJQIu4ZKvQ
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0X2pob3VzZV9jb20iLCJleHAiOjE3MDI3ODg1MjAsImF1dGgiOiJVU0VSIiwidHlwZSI6Ik5PTkUifQ.ZuMFHTTspFVatSst53X3vn4fzlhtwvgEtpzzyGPRdN2-SEmbQ48gYFatmEMRi74HcRPLnFM_UBsLSvn85KpA-w
Host: localhost:8080</code></pre>
</div>
</div>
Expand All @@ -971,18 +971,18 @@ <h5 id="_response_11">Response</h5>
"message" : "성공",
"data" : {
"content" : [ {
"commentId" : 31791,
"boardId" : 1312,
"commentId" : 33760,
"boardId" : 1389,
"title" : "짱구는 못말려",
"commentContent" : "댓글이란다."
}, {
"commentId" : 31790,
"boardId" : 1312,
"commentId" : 33759,
"boardId" : 1389,
"title" : "짱구는 못말려",
"commentContent" : "댓글이란다."
}, {
"commentId" : 31789,
"boardId" : 1311,
"commentId" : 33758,
"boardId" : 1388,
"title" : "짱구는 못말려",
"commentContent" : "댓글이란다."
} ],
Expand All @@ -994,8 +994,8 @@ <h5 id="_response_11">Response</h5>
"number" : 0,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
"unsorted" : true,
"sorted" : false
},
"numberOfElements" : 3,
"empty" : false
Expand All @@ -1012,7 +1012,7 @@ <h5 id="_request_12">Request</h5>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/v1/boards/my/love?page=0 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0X2pob3VzZV9jb20iLCJleHAiOjE3MDI2NTE0MjUsImF1dGgiOiJVU0VSIiwidHlwZSI6Ik5PTkUifQ.D-BDiHaZKjSbMX9W0AWjguc5nGajmnnoSqkLQuVTa8E9vhEVHx-Ka8Zr6WNhtr2_6WKnUfx05cCMaJQIu4ZKvQ
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0X2pob3VzZV9jb20iLCJleHAiOjE3MDI3ODg1MjAsImF1dGgiOiJVU0VSIiwidHlwZSI6Ik5PTkUifQ.ZuMFHTTspFVatSst53X3vn4fzlhtwvgEtpzzyGPRdN2-SEmbQ48gYFatmEMRi74HcRPLnFM_UBsLSvn85KpA-w
Host: localhost:8080</code></pre>
</div>
</div>
Expand All @@ -1033,19 +1033,19 @@ <h5 id="_response_12">Response</h5>
"message" : "성공",
"data" : {
"content" : [ {
"boardId" : 1305,
"boardId" : 1382,
"title" : "짱구는 못말려",
"oneLineContent" : "짱구는 못말려철수야 나랑 놀자",
"createdAt" : "2023-12-15T14:13:45.218+00:00",
"createdAt" : "2023-12-17T04:18:40.253+00:00",
"imageUrl" : "img001",
"category" : "TREND",
"prefixCategory" : "INTRO",
"commentCnt" : 1
}, {
"boardId" : 1306,
"boardId" : 1383,
"title" : "짱구는 못말려",
"oneLineContent" : "짱구는 못말려철수야 나랑 놀자",
"createdAt" : "2023-12-15T14:13:45.247+00:00",
"createdAt" : "2023-12-17T04:18:40.274+00:00",
"imageUrl" : "img001",
"category" : "TREND",
"prefixCategory" : "INTRO",
Expand All @@ -1059,8 +1059,8 @@ <h5 id="_response_12">Response</h5>
"number" : 0,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
"unsorted" : true,
"sorted" : false
},
"numberOfElements" : 2,
"empty" : false
Expand Down
Loading