Skip to content

Commit

Permalink
docs: 회원 탈퇴 문서 작성 #117
Browse files Browse the repository at this point in the history
  • Loading branch information
chaewss committed Apr 21, 2024
1 parent ff7c42a commit bb11aed
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions src/docs/asciidoc/api-doc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,13 @@ include::{snippets}/user-controller-test/respond_200_when_update_user_succeed/ht
| `409 CONFLICT` | `DUPLICATE_NICKNAME` | 해당하는 닉네임을 가진 유저가 이미 있는 경우
|===

=== 1-7. 회원 팔로우 생성
=== 1-7. 회원 삭제
==== Sample Request
include::{snippets}/user-controller-test/respond_200_when_delete_user_succeed/http-request.adoc[]
==== Sample Response
include::{snippets}/user-controller-test/respond_200_when_delete_user_succeed/http-response.adoc[]

=== 1-8. 회원 팔로우 생성
==== Path Parameters
include::{snippets}/user-controller-test/respond_201_when_create_user_follow_succeed/path-parameters.adoc[]
==== Sample Request
Expand All @@ -85,7 +91,7 @@ include::{snippets}/user-controller-test/respond_201_when_create_user_follow_suc
| `409 CONFLICT` | `DUPLICATE_USER_FOLLOW` | 해당하는 유저 팔로우가 이미 있는 경우
|===

=== 1-8. 회원 팔로우 삭제
=== 1-9. 회원 팔로우 삭제
==== Path Parameters
include::{snippets}/user-controller-test/respond_200_when_delete_user_follow_succeed/path-parameters.adoc[]
==== Sample Request
Expand All @@ -100,7 +106,7 @@ include::{snippets}/user-controller-test/respond_200_when_delete_user_follow_suc
| `404 NOT FOUND` | `NOT_FOUND_USER_FOLLOW` | 해당하는 팔로우가 없는 경우
|===

=== 1-9. 태그 매칭률 조회
=== 1-10. 태그 매칭률 조회
==== Path Parameters
include::{snippets}/user-controller-test/respond_200_when_read_user_tag_match_percentage_successfully/path-parameters.adoc[]
==== Sample Request
Expand All @@ -116,7 +122,7 @@ include::{snippets}/user-controller-test/respond_200_when_read_user_tag_match_pe
| `404 NOT FOUND` | `NOT_FOUND_USER` | 해당하는 유저가 없는 경우
|===

=== 1-10. 특정 회원의 좋아요 상품 목록 조회
=== 1-11. 특정 회원의 좋아요 상품 목록 조회
==== Path Parameters
include::{snippets}/user-controller-test/respond_200_when_read_liked_product_list_successfully/path-parameters.adoc[]
==== Request Fields
Expand All @@ -136,7 +142,7 @@ include::{snippets}/user-controller-test/respond_200_when_read_liked_product_lis
==== Sample Response
include::{snippets}/user-controller-test/respond_200_when_read_liked_product_list_successfully/http-response.adoc[]

=== 1-11. 특정 회원의 북마크 상품 목록 조회
=== 1-12. 특정 회원의 북마크 상품 목록 조회
==== Path Parameters
include::{snippets}/user-controller-test/respond_200_when_read_bookmarked_product_list_successfully/path-parameters.adoc[]
==== Request Fields
Expand All @@ -156,9 +162,12 @@ include::{snippets}/user-controller-test/respond_200_when_read_bookmarked_produc
==== Sample Response
include::{snippets}/user-controller-test/respond_200_when_read_bookmarked_product_list_successfully/http-response.adoc[]

=== 1-11. 특정 사용자의 리뷰 목록 조회
=== 1-13. 특정 사용자의 리뷰 목록 조회
==== Request Fields
==== Path Parameters
include::{snippets}/user-controller-test/respond_200_when_read_user_review_list_successfully/path-parameters.adoc[]
==== Request Fields
include::{snippets}/user-controller-test/respond_200_when_read_user_review_list_successfully/request-fields.adoc[]
include::{snippets}/user-controller-test/respond_200_when_read_user_review_list_successfully/query-parameters.adoc[]
==== 정렬 기준 항목
|===
| sortBy 값 | 정렬 기준 | 비고
Expand Down

0 comments on commit bb11aed

Please sign in to comment.