Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,5 @@ out/

### VS Code ###
.vscode/

src/main/resources/static/docs/
13 changes: 6 additions & 7 deletions src/docs/asciidoc/auth.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

비회원의 토큰을 발급받을 수 있습니다.

- 비회원의 토큰 만료일: 토큰 생성일로부터 1달
- 비회원 토큰의 만료일은 발급일로부터 1개월입니다.

=== Example

Expand All @@ -30,7 +30,7 @@ include::{snippets}/auth-controller-test/get-guest-token/response-body.adoc[]

== 액세스 토큰 재발급

refreshToken을 사용해 accessToken을 재발급 받을 수 있습니다.
`refreshToken`을 사용해 `accessToken`을 재발급받을 수 있습니다.

=== Example

Expand All @@ -54,8 +54,8 @@ include::{snippets}/auth-controller-test/reissue-access-token/response-body.adoc

== 카카오톡 소셜 로그인

사용자가 카카오 소셜 로그인을 완료하면, 인가 코드를 통해 카카오 Access Token을 발급받고, 이를 이용해 카카오 사용자 정보를 조회합니다.
조회된 사용자 정보로 서비스의 Access Token을 생성한 후, 해당 토큰은 쿠키를 통해 클라이언트에 전달됩니다.
사용자가 카카오 소셜 로그인을 완료하면 인가 코드를 통해 카카오 `Access Token`을 발급받습니다.
발급된 토큰으로 카카오 사용자 정보를 조회한 뒤, 서비스의 `Access Token`을 생성해 쿠키로 전달합니다.

=== Example

Expand All @@ -79,7 +79,7 @@ include::{snippets}/auth-controller-test/kakao-login-callback/response-body.adoc

== 로그아웃

서비스와 카카오 로그아웃을 처리합니다.
서비스 로그아웃과 카카오 로그아웃을 처리할 수 있습니다.

=== Example

Expand All @@ -103,7 +103,7 @@ include::{snippets}/auth-controller-test/kakao-logout/response-body.adoc[]

== 카카오 탈퇴

카카오 소셜로그인 사용자의 서비스 탈퇴 처리합니다.
카카오 소셜 로그인 사용자의 서비스 탈퇴를 처리할 수 있습니다.

=== Example

Expand Down Expand Up @@ -154,4 +154,3 @@ include::{snippets}/auth-controller-test/check-auth-success/response-body.adoc[]
include::{snippets}/auth-controller-test/check-auth-expired/response-body.adoc[]

include::{snippets}/auth-controller-test/check-auth-invalid-token/response-body.adoc[]

40 changes: 5 additions & 35 deletions src/docs/asciidoc/character.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,9 @@

모임의 캐릭터를 조회할 수 있습니다.

- ★:
러키 모또

- ★★:
천사 모또 / 딸기 또또

- ★★★:
마법사 또또 / 잠꾸러기 또또
- ★: 러키 모또
- ★★: 천사 모또 / 딸기 또또
- ★★★: 마법사 또또 / 잠꾸러기 또또


=== Example
Expand All @@ -36,35 +31,10 @@ include::{snippets}/character-controller-test/get-character-success/http-respons

include::{snippets}/character-controller-test/get-character-success/response-body.adoc[]

==== 응답 - 유효하지 않은 GroupToken
==== 응답 - 유효하지 않은 그룹 토큰

include::{snippets}/character-controller-test/get-character-invalid-token/response-body.adoc[]

==== 응답 - 누락된 GroupToken
==== 응답 - 누락된 그룹 토큰

include::{snippets}/character-controller-test/get-character-missing-token/response-body.adoc[]

== 도감 조회

사용자의 캐릭터 수집 현황을 조회할 수 있습니다.

=== Example

include::{snippets}/collection-controller-test/get-my-collections/curl-request.adoc[]

=== HTTP

==== 요청

include::{snippets}/collection-controller-test/get-my-collections/http-request.adoc[]

==== 응답

include::{snippets}/collection-controller-test/get-my-collections/http-response.adoc[]

=== Body

==== 응답

include::{snippets}/collection-controller-test/get-my-collections/response-body.adoc[]

27 changes: 27 additions & 0 deletions src/docs/asciidoc/collection.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
= 도감 (Collection)
:toc: left
:toclevels: 2

== 도감 조회

로그인한 사용자의 캐릭터 수집 현황을 조회할 수 있습니다.

=== Example

include::{snippets}/collection-controller-test/get-my-collections/curl-request.adoc[]

=== HTTP

==== 요청

include::{snippets}/collection-controller-test/get-my-collections/http-request.adoc[]

==== 응답

include::{snippets}/collection-controller-test/get-my-collections/http-response.adoc[]

=== Body

==== 응답

include::{snippets}/collection-controller-test/get-my-collections/response-body.adoc[]
38 changes: 23 additions & 15 deletions src/docs/asciidoc/expense.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ include::{snippets}/expense-controller-test/save-expenses-success/curl-request.a

include::{snippets}/expense-controller-test/save-expenses-success/http-request.adoc[]

include::{snippets}/expense-controller-test/create-expense/path-parameters.adoc[]

==== 응답

include::{snippets}/expense-controller-test/save-expenses-success/http-response.adoc[]
Expand All @@ -38,9 +40,8 @@ include::{snippets}/expense-controller-test/save-expenses-fail_when-member-not-f

모임의 전체 지출 내역을 조회할 수 있습니다.

- 조회시 날짜를 기준으로 오름차순으로 조회됩니다.

- 참여자의 지출 내역까지 함께 조회됩니다.
- 날짜 기준 오름차순으로 조회됩니다.
- 참여자별 지출 내역도 함께 조회됩니다.

=== Example

Expand All @@ -62,8 +63,6 @@ include::{snippets}/expense-controller-test/get-all-by-settlement-id-success/htt

include::{snippets}/expense-controller-test/get-all-by-settlement-id-success/response-body.adoc[]

==== 응답 -

== 단일 지출 내역 조회

지출 내역 하나를 조회할 수 있습니다.
Expand All @@ -78,6 +77,8 @@ include::{snippets}/expense-controller-test/get-by-expense-id-success/curl-reque

include::{snippets}/expense-controller-test/get-by-expense-id-success/http-request.adoc[]

include::{snippets}/expense-controller-test/get-by-expense-id-success/path-parameters.adoc[]

==== 응답

include::{snippets}/expense-controller-test/get-by-expense-id-success/http-response.adoc[]
Expand All @@ -88,17 +89,16 @@ include::{snippets}/expense-controller-test/get-by-expense-id-success/http-respo

include::{snippets}/expense-controller-test/get-by-expense-id-success/response-body.adoc[]

==== 응답 - 찾을 수 없는 지출내역
==== 응답 - 찾을 수 없는 지출 내역

include::{snippets}/expense-controller-test/get-by-expense-id-fail_when-expense-not-found/response-body.adoc[]

== 지출 상세 내역 조회

정산 내역의 전체 정산 내역을 조회합니다.

- 조회시 날짜를 기준으로 오름차순으로 정렬됩니다.
정산의 전체 지출 상세 내역을 조회할 수 있습니다.

- 참여자의 이름을 List값으로 가져옵니다.
- 날짜 기준 오름차순으로 정렬됩니다.
- 참여자 이름은 목록 형태로 제공됩니다.

=== Example

Expand All @@ -110,6 +110,8 @@ include::{snippets}/expense-controller-test/get-expense-details-success/curl-req

include::{snippets}/expense-controller-test/get-expense-details-success/http-request.adoc[]

include::{snippets}/expense-controller-test/get-expense-details-success/path-parameters.adoc[]

==== 응답

include::{snippets}/expense-controller-test/get-expense-details-success/http-response.adoc[]
Expand All @@ -124,7 +126,7 @@ include::{snippets}/expense-controller-test/get-expense-details-success/response

지출 내역을 수정할 수 있습니다.

- id = expenseId
- 경로의 `expenseId`를 기준으로 수정합니다.

=== Example

Expand All @@ -137,6 +139,8 @@ include::{snippets}/expense-controller-test/update-expense-success/httpie-reques

include::{snippets}/expense-controller-test/update-expense-success/http-request.adoc[]

include::{snippets}/expense-controller-test/update-expense-success/path-parameters.adoc[]

==== 응답

include::{snippets}/expense-controller-test/update-expense-success/http-response.adoc[]
Expand All @@ -151,13 +155,13 @@ include::{snippets}/expense-controller-test/update-expense-success/request-body.

include::{snippets}/expense-controller-test/update-expense-success/response-body.adoc[]

==== 응답 - 찾을 수 없는 지출내역
==== 응답 - 찾을 수 없는 지출 내역

include::{snippets}/expense-controller-test/get-by-expense-id-fail_when-expense-not-found/response-body.adoc[]

== 지출 내역 삭제

지출 내역을 삭제합니다.
지출 내역을 삭제할 수 있습니다.

=== Example

Expand All @@ -169,13 +173,15 @@ include::{snippets}/expense-controller-test/delete-expense-success/curl-request.

include::{snippets}/expense-controller-test/delete-expense-success/http-request.adoc[]

include::{snippets}/expense-controller-test/delete-expense-success/path-parameters.adoc[]

==== 응답

include::{snippets}/expense-controller-test/delete-expense-success/http-response.adoc[]

== 지출 이미지 URL 수정

지출 내역별 이미지 URL을 업데이트할 수 있습니다.
지출 내역별 이미지 URL을 수정할 수 있습니다.

=== Example

Expand All @@ -187,6 +193,8 @@ include::{snippets}/expense-controller-test/update-img-url-success/curl-request.

include::{snippets}/expense-controller-test/update-img-url-success/http-request.adoc[]

include::{snippets}/expense-controller-test/update-img-url-success/path-parameters.adoc[]

==== 응답

include::{snippets}/expense-controller-test/update-img-url-success/http-response.adoc[]
Expand All @@ -195,4 +203,4 @@ include::{snippets}/expense-controller-test/update-img-url-success/http-response

==== 요청

include::{snippets}/expense-controller-test/update-img-url-success/request-body.adoc[]
include::{snippets}/expense-controller-test/update-img-url-success/request-body.adoc[]
6 changes: 3 additions & 3 deletions src/docs/asciidoc/image.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

== 이미지 임시 저장

지출내역 작성 완료 전, 임시로 이미지를 저장할 수 있습니다.
지출 내역 작성 완료 전에 이미지를 임시 저장할 수 있습니다.

=== Example

Expand All @@ -28,7 +28,7 @@ include::{snippets}/image-controller-test/save-temp-image-success/response-body.

== 이미지 실제 저장

지출내역 작성 후, 임시로 저장된 이미지를 실제 폴더에 업로드할 수 있습니다.
지출 내역 작성 후 임시 저장된 이미지를 실제 폴더에 업로드할 수 있습니다.

=== Example

Expand All @@ -48,4 +48,4 @@ include::{snippets}/image-controller-test/update-image-success/http-response.ado

==== 응답

include::{snippets}/image-controller-test/update-image-success/response-body.adoc[]
include::{snippets}/image-controller-test/update-image-success/response-body.adoc[]
2 changes: 2 additions & 0 deletions src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ include::user.adoc[]

include::character.adoc[]

include::collection.adoc[]

include::expense.adoc[]

include::settlement.adoc[]
Expand Down
Loading
Loading