Skip to content

docs: 로그인 로그아웃 api docs 추가 #6

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

Merged
sudhdkso merged 1 commit into from
Jul 15, 2025
Merged

docs: 로그인 로그아웃 api docs 추가 #6

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
26 changes: 25 additions & 1 deletion src/docs/asciidoc/auth.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,28 @@ include::{snippets}/auth-controller-test/kakao-login-callback/http-response.adoc

==== 응답

include::{snippets}/auth-controller-test/kakao-login-callback/response-body.adoc[]
include::{snippets}/auth-controller-test/kakao-login-callback/response-body.adoc[]

== 로그아웃

서비스와 카카오 로그아웃을 처리합니다.

=== Example

include::{snippets}/auth-controller-test/kakao-logout/curl-request.adoc[]

=== HTTP

==== 요청

include::{snippets}/auth-controller-test/kakao-logout/http-request.adoc[]

==== 응답

include::{snippets}/auth-controller-test/kakao-logout/http-response.adoc[]

=== Body

==== 응답

include::{snippets}/auth-controller-test/kakao-logout/response-body.adoc[]
4 changes: 3 additions & 1 deletion src/docs/asciidoc/expense.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,4 +195,6 @@ 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[]

operation::create-expense[snippets="path-parameters,http-request,request-body,request-fields,http-response"]
3 changes: 3 additions & 0 deletions src/docs/asciidoc/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
:toclevels: 2
:sectnums:


include::auth.adoc[]

include::character.adoc[]

include::expense.adoc[]
Expand Down
13 changes: 7 additions & 6 deletions src/test/java/com/dnd/moddo/domain/auth/controller/AuthControllerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import static org.mockito.BDDMockito.*;
import static org.springframework.restdocs.cookies.CookieDocumentation.*;
import static org.springframework.restdocs.headers.HeaderDocumentation.*;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.*;
import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.*;
import static org.springframework.restdocs.payload.PayloadDocumentation.*;
import static org.springframework.restdocs.request.RequestDocumentation.*;
Expand Down Expand Up @@ -42,8 +43,8 @@ void getGuestToken() throws Exception {
.andExpect(jsonPath("$.refreshToken").value("refresh-token"))
.andExpect(jsonPath("$.isMember").value(false))
.andDo(restDocs.document(
responseHeaders(
headerWithName("Set-Cookie").description("엑세스 토큰")
responseCookies(
cookieWithName("accessToken").description("엑세스 토큰")
),
responseFields(
fieldWithPath("accessToken").type(JsonFieldType.STRING).description("액세스 토큰"),
Expand Down Expand Up @@ -93,12 +94,12 @@ void kakaoLoginCallback() throws Exception {
mockMvc.perform(get("/api/v1/login/oauth2/callback")
.param("code", "test code"))
.andExpect(status().isOk())
.andDo(restDocs.document(
.andDo(document("login",
queryParameters(
parameterWithName("code").description("카카오 인가 코드")
),
responseHeaders(
headerWithName("Set-Cookie").description("엑세스 토큰")
responseCookies(
cookieWithName("accessToken").description("엑세스 토큰")
)
));
}
Expand All @@ -114,7 +115,7 @@ void kakaoLogout() throws Exception {
mockMvc.perform(get("/api/v1/logout")
.cookie(new Cookie("accessToken", "access-token")))
.andExpect(status().isOk())
.andDo(restDocs.document(
.andDo(document("logout",
requestCookies(
cookieWithName("accessToken").description("액세스 토큰")
),
Expand Down
43 changes: 41 additions & 2 deletions src/test/java/com/dnd/moddo/domain/expense/controller/ExpenseControllerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@
import static org.hamcrest.Matchers.*;
import static org.mockito.BDDMockito.any;
import static org.mockito.BDDMockito.*;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.*;
import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.*;
import static org.springframework.restdocs.payload.PayloadDocumentation.*;
import static org.springframework.restdocs.request.RequestDocumentation.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;

import java.time.LocalDate;
Expand All @@ -13,6 +16,7 @@
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.http.MediaType;
import org.springframework.restdocs.payload.JsonFieldType;

import com.dnd.moddo.domain.expense.dto.request.ExpenseImageRequest;
import com.dnd.moddo.domain.expense.dto.request.ExpenseRequest;
Expand Down Expand Up @@ -74,7 +78,21 @@ void saveExpensesSuccess() throws Exception {
.param("groupToken", groupToken)
.contentType(MediaType.APPLICATION_JSON)
.content(objectMapper.writeValueAsString(request)))
.andExpect(status().isOk());
.andExpect(status().isOk())
.andDo(document("create-expense",
requestFields(
fieldWithPath("expenses").type(JsonFieldType.ARRAY).description("지출 항목 목록"),
fieldWithPath("expenses[].amount").type(JsonFieldType.NUMBER).description("지출 금액"),
fieldWithPath("expenses[].content").type(JsonFieldType.STRING).description("지출 내용"),
fieldWithPath("expenses[].date").type(JsonFieldType.STRING).description("지출 일자 (yyyy-MM-dd)"),
fieldWithPath("expenses[].memberExpenses").type(JsonFieldType.ARRAY).description("멤버별 지출 내역"),
fieldWithPath("expenses[].memberExpenses[].id").type(JsonFieldType.NUMBER)
.description("멤버 ID"),
fieldWithPath("expenses[].memberExpenses[].amount").type(JsonFieldType.NUMBER)
.description("멤버가 실제로 부담한 금액")
))
)
;
}

@Test
Expand Down Expand Up @@ -123,7 +141,28 @@ void getAllByGroupIdSuccess() throws Exception {
.andExpect(status().isOk())
.andExpect(jsonPath("$.expenses.length()").value(4))
.andExpect(jsonPath("$.expenses[0].id").value(1))
.andExpect(jsonPath("$.expenses[0].memberExpenses[0].name").value("김모또"));
.andExpect(jsonPath("$.expenses[0].memberExpenses[0].name").value("김모또"))
.andDo(document("get-expenses",
queryParameters(
parameterWithName("groupToken").description("조회할 그룹 토큰")
),
responseFields(
fieldWithPath("expenses").type(JsonFieldType.ARRAY).description("지출 내역 목록"),
fieldWithPath("expenses[].id").type(JsonFieldType.NUMBER).description("지출 ID"),
fieldWithPath("expenses[].amount").type(JsonFieldType.NUMBER).description("지출 금액"),
fieldWithPath("expenses[].content").type(JsonFieldType.STRING).description("지출 내역 내용"),
fieldWithPath("expenses[].date").type(JsonFieldType.STRING).description("지출 날짜 (yyyy-MM-dd)"),
fieldWithPath("expenses[].memberExpenses").type(JsonFieldType.ARRAY).description("멤버별 지출 상세"),
fieldWithPath("expenses[].memberExpenses[].id").type(JsonFieldType.NUMBER).description("멤버 ID"),
fieldWithPath("expenses[].memberExpenses[].name").type(JsonFieldType.STRING).description("멤버 이름"),
fieldWithPath("expenses[].memberExpenses[].role").type(JsonFieldType.STRING)
.description("멤버 역할(MANAGER/PARTICIPANT)"),
fieldWithPath("expenses[].memberExpenses[].profile").type(JsonFieldType.STRING)
.description("프로필 이미지 URL"),
fieldWithPath("expenses[].memberExpenses[].amount").type(JsonFieldType.NUMBER)
.description("해당 멤버의 지출 금액")
)
));
}

@Test
Expand Down
Loading