From d511c6c77e1696709b081ac8d1dadf82baea34f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?user=20=EC=9D=B4=EB=A6=84?= Date: Tue, 30 Jan 2024 19:46:57 +0900 Subject: [PATCH 1/3] =?UTF-8?q?hotfix=20[hotfix]=20identifier=EB=A5=BC=20u?= =?UTF-8?q?nique=ED=95=98=EB=8F=84=EB=A1=9D=20=EB=B3=80=EA=B2=BD?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/docs/asciidoc/delete-user-v2.adoc | 29 +++++++++++++++++++ .../user/medium/UserControllerTest.java | 2 +- 2 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 src/docs/asciidoc/delete-user-v2.adoc diff --git a/src/docs/asciidoc/delete-user-v2.adoc b/src/docs/asciidoc/delete-user-v2.adoc new file mode 100644 index 00000000..1938a368 --- /dev/null +++ b/src/docs/asciidoc/delete-user-v2.adoc @@ -0,0 +1,29 @@ +:reproducible: +== 탈퇴 & 사유 저장 v2 + +=== 요청 + +include::{snippets}/api/v2/user/deleteUser/http-request.adoc[] + +=== 응답 + +include::{snippets}/api/v2/user/deleteUser/http-response.adoc[] + +*필드 타입* + +- "value": String +* value는 탈퇴 사유를 보내주시면 됩니다. + + +*필드 타입* + +=== NOTE + +- AccessToken에 해당하는 User의 탈퇴 처리 및 탈퇴 사유를 저장하는 API입니다. +// - User의 다양한 정보를 저장하는 API로 범용적인 확장할 예정입니다. +// * 차후에 tag에 들어갈 수 있는 ENUM의 종류를 다양화 할 예정입니다. + +=== CHANGELOG + +- 2024.01.27 API 릴리즈 +- 2024.01.09 명세 작성 \ No newline at end of file diff --git a/src/test/java/com/yello/server/domain/user/medium/UserControllerTest.java b/src/test/java/com/yello/server/domain/user/medium/UserControllerTest.java index d18430a3..4dacbe4e 100644 --- a/src/test/java/com/yello/server/domain/user/medium/UserControllerTest.java +++ b/src/test/java/com/yello/server/domain/user/medium/UserControllerTest.java @@ -268,7 +268,7 @@ void init() { .contentType(MediaType.APPLICATION_JSON) .content(objectMapper.writeValueAsString(request))) .andDo(print()) - .andDo(document("api/v2/user", + .andDo(document("api/v2/user/deleteUser", Preprocessors.preprocessRequest(prettyPrint(), removeHeaders(excludeRequestHeaders)), Preprocessors.preprocessResponse(prettyPrint(), From 8a79775f3191f31727e32b07ab3a245643ac81a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?user=20=EC=9D=B4=EB=A6=84?= Date: Tue, 30 Jan 2024 19:47:08 +0900 Subject: [PATCH 2/3] =?UTF-8?q?hotfix=20[hotfix]=20=EC=9C=A0=EC=A0=80=20?= =?UTF-8?q?=EC=A0=95=EB=B3=B4=20=EC=A0=80=EC=9E=A5=20=EB=AA=85=EC=84=B8=20?= =?UTF-8?q?=EB=B6=84=EB=A6=AC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/docs/asciidoc/index.adoc | 6 +++-- src/docs/asciidoc/user-data-post.adoc | 37 +++++++++++++++++++-------- 2 files changed, 31 insertions(+), 12 deletions(-) diff --git a/src/docs/asciidoc/index.adoc b/src/docs/asciidoc/index.adoc index d31ff590..bab5eaca 100644 --- a/src/docs/asciidoc/index.adoc +++ b/src/docs/asciidoc/index.adoc @@ -39,7 +39,7 @@ * 🆕 link:user-data-get.html[프로필 수정 가능 여부 조회 (명세), 2024-01-09] -* 🆕 link:user-data-post.html[탈퇴 사유 저장 (명세), 2024-01-09] +* 🆕 link:user-data-post.html[유저 기타 정보 저장 (명세), 2024-01-30] * 🆕 link:purchase-info.html[유저 구독 정보, 2024-01-25] @@ -49,13 +49,15 @@ * link:delete-user.html[유저 탈퇴] +* 🆕 link:delete-user-v2.html[유저 탈퇴 V2, 2024-01-30] + === Vote API * link:find-votes.html[내 투표 전체 조회하기] * link:find-friend-votes.html[친구 투표 전체 조회하기, 2024-01-09] -* ⬆️ link:find-friend-votes-v2.html[친구 투표 전체 조회하기 v2 (명세), 2024-01-26] +* 🆕️ link:find-friend-votes-v2.html[친구 투표 전체 조회하기 v2 (명세), 2024-01-26] * link:get-unread-vote.html[읽지 않은 쪽지 개수 조회하기] diff --git a/src/docs/asciidoc/user-data-post.adoc b/src/docs/asciidoc/user-data-post.adoc index 613e4d98..39db165b 100644 --- a/src/docs/asciidoc/user-data-post.adoc +++ b/src/docs/asciidoc/user-data-post.adoc @@ -1,30 +1,47 @@ :reproducible: -== 탈퇴 & 사유 저장 v2 +== 유저 기타 정보 저장 (명세) === 요청 -include::{snippets}/api/v2/user/http-request.adoc[] - -=== 응답 - -include::{snippets}/api/v2/user/http-response.adoc[] +[http] +---- +POST /api/v1/user/data/recommended HTTP/1.1 +Authorization: Bearer your-access-token +Content-Type: application-json +{ + "value": "true" +} +---- *필드 타입* +- "tag": "withdraw-reason" | "account-update-at" | "recommended" +* withdraw-reason 자리가 ENUM으로 대체될 예정입니다. - "value": String -* value는 탈퇴 사유를 보내주시면 됩니다. +=== 응답 -*필드 타입* +[http,json] +---- +HTTP/1.1 200 OK +Vary: Origin +Vary: Access-Control-Request-Method +Vary: Access-Control-Request-Headers +Content-Type: application/json + +{ + "status" : 200, + "message" : "탈퇴 사유 정보 저장에 성공하였습니다." +} +---- === NOTE -- AccessToken에 해당하는 User의 탈퇴 사유를 저장하는 API입니다. - User의 다양한 정보를 저장하는 API로 범용적인 확장할 예정입니다. * 차후에 tag에 들어갈 수 있는 ENUM의 종류를 다양화 할 예정입니다. === CHANGELOG -- 2024.01.27 API 릴리즈 +- 2024.01.30 탈퇴 v2 분리로 인한 명세 업데이트 - 2024.01.09 명세 작성 \ No newline at end of file From 589c7e23d275d069ac91a95f0e7c7d5a5ad2ed56 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?user=20=EC=9D=B4=EB=A6=84?= Date: Tue, 30 Jan 2024 19:47:28 +0900 Subject: [PATCH 3/3] =?UTF-8?q?hotfix=20[hotfix]=20=EB=AA=85=EC=84=B8?= =?UTF-8?q?=EC=84=9C=20=EC=82=B0=EC=B6=9C=EB=AC=BC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../resources/static/docs/delete-user-v2.html | 530 ++++++++++++++++++ src/main/resources/static/docs/index.html | 7 +- .../resources/static/docs/user-data-post.html | 78 +-- 3 files changed, 564 insertions(+), 51 deletions(-) create mode 100644 src/main/resources/static/docs/delete-user-v2.html diff --git a/src/main/resources/static/docs/delete-user-v2.html b/src/main/resources/static/docs/delete-user-v2.html new file mode 100644 index 00000000..5dc1d444 --- /dev/null +++ b/src/main/resources/static/docs/delete-user-v2.html @@ -0,0 +1,530 @@ + + + + + + + +탈퇴 & 사유 저장 v2 + + + + + +
+
+

탈퇴 & 사유 저장 v2

+
+
+

요청

+
+
+
DELETE /api/v2/user HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Authorization: Bearer your-access-token
+Content-Length: 37
+
+{
+  "value" : "오류가 많아서"
+}
+
+
+
+
+

응답

+
+
+
HTTP/1.1 200 OK
+Vary: Origin
+Vary: Access-Control-Request-Method
+Vary: Access-Control-Request-Headers
+Content-Type: application/json
+
+{
+  "status" : 200,
+  "message" : "유저 탈퇴에 성공했습니다."
+}
+
+
+
+

필드 타입

+
+
+
    +
  • +

    "value": String

    +
    +
      +
    • +

      value는 탈퇴 사유를 보내주시면 됩니다.

      +
      • +
    +
    +
    • +
+
+
+

필드 타입

+
+
+
+

NOTE

+
+
    +
  • +

    AccessToken에 해당하는 User의 탈퇴 처리 및 탈퇴 사유를 저장하는 API입니다.

    +
    • +
+
+
+
+

CHANGELOG

+
+
    +
  • +

    2024.01.27 API 릴리즈

    +
    • +
  • +

    2024.01.09 명세 작성

    +
    • +
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/src/main/resources/static/docs/index.html b/src/main/resources/static/docs/index.html index 0edb8563..5425a8dd 100644 --- a/src/main/resources/static/docs/index.html +++ b/src/main/resources/static/docs/index.html @@ -512,7 +512,7 @@

User API

🆕 프로필 수정 가능 여부 조회 (명세), 2024-01-09

  • -

    🆕 탈퇴 사유 저장 (명세), 2024-01-09

    +

    🆕 유저 기타 정보 저장 (명세), 2024-01-30

  • 🆕 유저 구독 정보, 2024-01-25

    @@ -526,6 +526,9 @@

    User API

  • 유저 탈퇴

    • +
  • +

    🆕 유저 탈퇴 V2, 2024-01-30

    +
    • @@ -540,7 +543,7 @@

    Vote API

    친구 투표 전체 조회하기, 2024-01-09

  • -

    ⬆️ 친구 투표 전체 조회하기 v2 (명세), 2024-01-26

    +

    🆕️ 친구 투표 전체 조회하기 v2 (명세), 2024-01-26

  • 읽지 않은 쪽지 개수 조회하기

    diff --git a/src/main/resources/static/docs/user-data-post.html b/src/main/resources/static/docs/user-data-post.html index 9e5c9a7f..006b94cf 100644 --- a/src/main/resources/static/docs/user-data-post.html +++ b/src/main/resources/static/docs/user-data-post.html @@ -5,7 +5,7 @@ -탈퇴 & 사유 저장 v2 +유저 기타 정보 저장 (명세)