Skip to content

Commit d28cf86

Browse files
committed
chore : fix swagger documentation
1 parent 9070dff commit d28cf86

File tree

2 files changed

+17
-19
lines changed

2 files changed

+17
-19
lines changed

src/docs/asciidoc/index.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,15 +107,15 @@ Content-Type: application/json
107107
이메일 중복을 확인하는 api입니다.
108108

109109
==== Request
110-
include::{snippetsDir}/api/users/email/duplication/1/http-request.adoc[]
110+
include::{snippetsDir}/emailDuplicationCheck/1/http-request.adoc[]
111111

112112
==== Request Query Parameter Fields
113-
include::{snippetsDir}/api/users/email/duplication/1/query-parameters.adoc[]
113+
include::{snippetsDir}/emailDuplicationCheck/1/query-parameters.adoc[]
114114

115115
==== 성공 Response
116-
include::{snippetsDir}/api/users/email/duplication/1/http-response.adoc[]
116+
include::{snippetsDir}/emailDuplicationCheck/1/http-response.adoc[]
117117

118118
==== Response Body Fields
119-
include::{snippetsDir}/api/users/email/duplication/1/response-fields.adoc[]
119+
include::{snippetsDir}/emailDuplicationCheck/1/response-fields.adoc[]
120120

121121
---

src/test/java/com/ftm/server/user/EmailDuplicationCheckTest.java

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,10 @@
2424

2525
public class EmailDuplicationCheckTest extends BaseTest {
2626

27-
private final List<ParameterDescriptor> queryParametersForEmail =
28-
List.of(
29-
parameterWithName("email")
30-
.description("중복 확인 email")
31-
.attributes(new Attributes.Attribute("constraint", "email 형식")));
27+
private final ParameterDescriptor queryParametersForEmail =
28+
parameterWithName("email")
29+
.description("중복 확인 email")
30+
.attributes(new Attributes.Attribute("constraint", "email 형식"));
3231

3332
private final List<FieldDescriptor> responseFieldDescriptorsForEmailDuplicationCheck =
3433
List.of(
@@ -39,27 +38,26 @@ public class EmailDuplicationCheckTest extends BaseTest {
3938
fieldWithPath("data.isDuplicated").type("Boolean").description("중복 여부"));
4039

4140
private ResultActions getResultActions(String email) throws Exception {
42-
return mockMvc.perform( // api 실행
41+
return mockMvc.perform(
4342
RestDocumentationRequestBuilders.get("/api/users/email/duplication")
44-
.param("email", email) // query parameter
45-
);
43+
.param("email", email));
4644
}
4745

4846
// 문서화 반환 함수
4947
private RestDocumentationResultHandler getDocument(Integer identifier) {
5048
return document(
51-
"api/users/email/duplication/" + identifier,
52-
preprocessRequest(prettyPrint()), // request 출력 형식 지정->host 이름 변경
53-
preprocessResponse(prettyPrint(), getModifiedHeader()), // response 출력 형식 지정
54-
responseFields(
55-
responseFieldDescriptorsForEmailDuplicationCheck), // response body field
56-
// descriptor
57-
queryParameters(queryParametersForEmail), // query parameter descriptor
49+
"emailDuplicationCheck/" + identifier,
50+
preprocessRequest(prettyPrint()),
51+
preprocessResponse(prettyPrint(), getModifiedHeader()),
52+
responseFields(responseFieldDescriptorsForEmailDuplicationCheck),
53+
queryParameters(queryParametersForEmail),
5854
resource(
5955
ResourceSnippetParameters.builder()
6056
.tag("회원")
6157
.summary("이메일 중복 확인 api")
6258
.description("email 중복 확인 api입니다.")
59+
.responseFields(responseFieldDescriptorsForEmailDuplicationCheck)
60+
.queryParameters(queryParametersForEmail)
6361
.build()));
6462
}
6563

0 commit comments

Comments
 (0)