diff --git a/src/docs/asciidoc/index.adoc b/src/docs/asciidoc/index.adoc index a2c8074..c5adf87 100644 --- a/src/docs/asciidoc/index.adoc +++ b/src/docs/asciidoc/index.adoc @@ -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[] --- diff --git a/src/test/java/com/ftm/server/user/EmailDuplicationCheckTest.java b/src/test/java/com/ftm/server/user/EmailDuplicationCheckTest.java index f3db733..b9998f5 100644 --- a/src/test/java/com/ftm/server/user/EmailDuplicationCheckTest.java +++ b/src/test/java/com/ftm/server/user/EmailDuplicationCheckTest.java @@ -24,11 +24,10 @@ public class EmailDuplicationCheckTest extends BaseTest { - private final List 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 responseFieldDescriptorsForEmailDuplicationCheck = List.of( @@ -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())); }