refactor: 봉사 모집글 등록(보호소)를 명세에 맞게 수정한다. (#146)

* refactor: 봉사 모집 등록(보호소) APILocation 헤더 값을 명세에 맞게 수정한다. * docs: 봉사 모집글 등록(보호소) API 문서화를 추가한다. * test: 봉사 모집글 등록(보호소) 문서화 테스트 코드를 수정한다.
anifriends · Nov 8, 2023 · 79fc62f · 79fc62f
1 parent 10e2755
commit 79fc62f
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 12 deletions.
diff --git a/src/docs/asciidoc/index.adoc b/src/docs/asciidoc/index.adoc
@@ -5,6 +5,18 @@
 :toclevels: 2
 :sectlinks:
 
+= 보호소
+
+== 봉사 모집
+
+=== 1) 봉사 모집글 등록
+
+==== Request
+operation::recruitment-controller-test/register-recruitment[snippets='http-request,request-headers,request-fields']
+
+==== Response
+operation::recruitment-controller-test/register-recruitment[snippets='http-response,response-headers']
+
 == #. Enum 문서화
 
 === 1. 보호 동물 성격

diff --git a/src/main/java/com/clova/anifriends/domain/recruitment/controller/RecruitmentController.java b/src/main/java/com/clova/anifriends/domain/recruitment/controller/RecruitmentController.java
@@ -36,17 +36,17 @@ public class RecruitmentController {
     @PostMapping("/shelters/recruitments")
     public ResponseEntity<RegisterRecruitmentResponse> registerRecruitment(
         @LoginUser Long userId,
-        @RequestBody @Valid RegisterRecruitmentRequest request) {
+        @RequestBody @Valid RegisterRecruitmentRequest registerRecruitmentRequest) {
         RegisterRecruitmentResponse response = recruitmentService.registerRecruitment(
             userId,
-            request.title(),
-            request.startTime(),
-            request.endTime(),
-            request.deadline(),
-            request.capacity(),
-            request.content(),
-            request.imageUrls());
-        URI location = URI.create("/api/shelters/recruitments/" + response.recruitmentId());
+            registerRecruitmentRequest.title(),
+            registerRecruitmentRequest.startTime(),
+            registerRecruitmentRequest.endTime(),
+            registerRecruitmentRequest.deadline(),
+            registerRecruitmentRequest.capacity(),
+            registerRecruitmentRequest.content(),
+            registerRecruitmentRequest.imageUrls());
+        URI location = URI.create("/api/recruitments/" + response.recruitmentId());
         return ResponseEntity.created(location).build();
     }
 

diff --git a/...st/java/com/clova/anifriends/domain/recruitment/controller/RecruitmentControllerTest.java b/...st/java/com/clova/anifriends/domain/recruitment/controller/RecruitmentControllerTest.java
@@ -108,11 +108,11 @@ void registerRecruitment() throws Exception {
                     fieldWithPath("deadline").type(JsonFieldType.STRING).description("봉사 모집 마감 시간")
                         .attributes(DocumentationFormatGenerator.getDatetimeConstraint()),
                     fieldWithPath("capacity").type(JsonFieldType.NUMBER).description("봉사 모집 정원")
-                        .description(DocumentationFormatGenerator.getConstraint("1명 이상, 99명 이하")),
+                        .attributes(DocumentationFormatGenerator.getConstraint("1명 이상, 99명 이하")),
                     fieldWithPath("content").type(JsonFieldType.STRING).description("봉사 모집글 본문")
-                        .description(DocumentationFormatGenerator.getConstraint("1자 이상, 1000자 이하")),
+                        .attributes(DocumentationFormatGenerator.getConstraint("1자 이상, 1000자 이하")),
                     fieldWithPath("imageUrls").type(JsonFieldType.ARRAY).description("봉사 모집글 이미지")
-                        .description(DocumentationFormatGenerator.getConstraint("0장 이상, 5장 이하"))
+                        .attributes(DocumentationFormatGenerator.getConstraint("0장 이상, 5장 이하"))
                         .optional()
                 ),
                 responseHeaders(