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
8 changes: 4 additions & 4 deletions src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -107,15 +107,15 @@ Content-Type: application/json
์ด๋ฉ”์ผ ์ค‘๋ณต์„ ํ™•์ธํ•˜๋Š” api์ž…๋‹ˆ๋‹ค.

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

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

==== ์„ฑ๊ณต Response
include::{snippetsDir}/api/users/email/duplication/1/http-response.adoc[]
include::{snippetsDir}/emailDuplicationCheck/1/http-response.adoc[]

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

---
28 changes: 13 additions & 15 deletions src/test/java/com/ftm/server/user/EmailDuplicationCheckTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,10 @@

public class EmailDuplicationCheckTest extends BaseTest {

private final List<ParameterDescriptor> queryParametersForEmail =
List.of(
parameterWithName("email")
.description("์ค‘๋ณต ํ™•์ธ email")
.attributes(new Attributes.Attribute("constraint", "email ํ˜•์‹")));
private final ParameterDescriptor queryParametersForEmail =
parameterWithName("email")
.description("์ค‘๋ณต ํ™•์ธ email")
.attributes(new Attributes.Attribute("constraint", "email ํ˜•์‹"));

private final List<FieldDescriptor> responseFieldDescriptorsForEmailDuplicationCheck =
List.of(
Expand All @@ -39,27 +38,26 @@ public class EmailDuplicationCheckTest extends BaseTest {
fieldWithPath("data.isDuplicated").type("Boolean").description("์ค‘๋ณต ์—ฌ๋ถ€"));

private ResultActions getResultActions(String email) throws Exception {
return mockMvc.perform( // api ์‹คํ–‰
return mockMvc.perform(
RestDocumentationRequestBuilders.get("/api/users/email/duplication")
.param("email", email) // query parameter
);
.param("email", email));
}

// ๋ฌธ์„œํ™” ๋ฐ˜ํ™˜ ํ•จ์ˆ˜
private RestDocumentationResultHandler getDocument(Integer identifier) {
return document(
"api/users/email/duplication/" + identifier,
preprocessRequest(prettyPrint()), // request ์ถœ๋ ฅ ํ˜•์‹ ์ง€์ •->host ์ด๋ฆ„ ๋ณ€๊ฒฝ
preprocessResponse(prettyPrint(), getModifiedHeader()), // response ์ถœ๋ ฅ ํ˜•์‹ ์ง€์ •
responseFields(
responseFieldDescriptorsForEmailDuplicationCheck), // response body field
// descriptor
queryParameters(queryParametersForEmail), // query parameter descriptor
"emailDuplicationCheck/" + identifier,
preprocessRequest(prettyPrint()),
preprocessResponse(prettyPrint(), getModifiedHeader()),
responseFields(responseFieldDescriptorsForEmailDuplicationCheck),
queryParameters(queryParametersForEmail),
resource(
ResourceSnippetParameters.builder()
.tag("ํšŒ์›")
.summary("์ด๋ฉ”์ผ ์ค‘๋ณต ํ™•์ธ api")
.description("email ์ค‘๋ณต ํ™•์ธ api์ž…๋‹ˆ๋‹ค.")
.responseFields(responseFieldDescriptorsForEmailDuplicationCheck)
.queryParameters(queryParametersForEmail)
.build()));
}

Expand Down