Skip to content

Commit 36bb983

Browse files
committed
CLAP-368 Docs: 폼 데이터 처리 스웨거 명세 추가
<footer> - #469
1 parent b9d35c2 commit 36bb983

File tree

4 files changed

+14
-3
lines changed

4 files changed

+14
-3
lines changed

src/main/java/clap/server/adapter/inbound/web/admin/RegisterMemberCsvController.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,11 @@
77
import clap.server.exception.AdapterException;
88
import clap.server.exception.code.FileErrorcode;
99
import io.swagger.v3.oas.annotations.Operation;
10+
import io.swagger.v3.oas.annotations.Parameter;
11+
import io.swagger.v3.oas.annotations.media.Content;
1012
import io.swagger.v3.oas.annotations.tags.Tag;
1113
import lombok.RequiredArgsConstructor;
14+
import org.springframework.http.MediaType;
1215
import org.springframework.http.ResponseEntity;
1316
import org.springframework.security.access.annotation.Secured;
1417
import org.springframework.security.core.annotation.AuthenticationPrincipal;
@@ -31,6 +34,7 @@ public class RegisterMemberCsvController {
3134
@Secured("ROLE_ADMIN")
3235
public ResponseEntity<String> registerMembersFromCsv(
3336
@AuthenticationPrincipal SecurityUserDetails userInfo,
37+
@Parameter(description = "csv, 엑셀 포맷 파일만 입력 가능합니다.", content = @Content(mediaType = MediaType.MULTIPART_FORM_DATA_VALUE))
3438
@RequestParam("file") MultipartFile file) throws IOException {
3539
if (!FileTypeValidator.validCSVFile(file.getInputStream())) {
3640
throw new AdapterException(FileErrorcode.UNSUPPORTED_FILE_TYPE);}

src/main/java/clap/server/adapter/inbound/web/history/PostCommentController.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
import io.swagger.v3.oas.annotations.Operation;
1111
import io.swagger.v3.oas.annotations.Parameter;
1212
import io.swagger.v3.oas.annotations.enums.ParameterIn;
13+
import io.swagger.v3.oas.annotations.media.Content;
1314
import io.swagger.v3.oas.annotations.tags.Tag;
1415
import jakarta.validation.Valid;
1516
import jakarta.validation.constraints.NotNull;
@@ -47,6 +48,7 @@ public void createComment(
4748
public void createAttachmentComment(
4849
@AuthenticationPrincipal SecurityUserDetails userInfo,
4950
@PathVariable Long taskId,
51+
@Parameter(content = @Content(mediaType = MediaType.MULTIPART_FORM_DATA_VALUE))
5052
@RequestPart(name = "attachment") @NotNull MultipartFile attachment) {
5153
saveCommentAttachmentUsecase.saveCommentAttachment(userInfo.getUserId(), taskId, attachment);
5254
}

src/main/java/clap/server/adapter/inbound/web/member/MemberInfoController.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
import clap.server.exception.ApplicationException;
1313
import clap.server.exception.code.FileErrorcode;
1414
import io.swagger.v3.oas.annotations.Operation;
15+
import io.swagger.v3.oas.annotations.Parameter;
16+
import io.swagger.v3.oas.annotations.media.Content;
1517
import io.swagger.v3.oas.annotations.tags.Tag;
1618
import lombok.RequiredArgsConstructor;
1719
import org.springframework.http.MediaType;
@@ -50,6 +52,7 @@ public ResponseEntity<MemberDetailInfoResponse> getMemberDetailInfo(@Authenticat
5052
@PatchMapping(value = "/info", consumes = {MediaType.MULTIPART_FORM_DATA_VALUE, MediaType.APPLICATION_JSON_VALUE})
5153
public void updateMemberDetailInfo(
5254
@RequestPart(name = "memberInfo") UpdateMemberInfoRequest request,
55+
@Parameter(description = "image/jpeg, image/pjpeg, image/png, image/gif, image/bmp, image/x-windows-bmp 형식만 가능합니다.", content = @Content(mediaType = MediaType.MULTIPART_FORM_DATA_VALUE))
5356
@RequestPart(name = "profileImage", required = false) MultipartFile profileImage,
5457
@AuthenticationPrincipal SecurityUserDetails userInfo) throws IOException {
5558
if (profileImage !=null && !FileTypeValidator.validImageFile(profileImage.getInputStream())) {

src/main/java/clap/server/adapter/inbound/web/task/ManagementTaskController.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
import clap.server.exception.AdapterException;
1313
import clap.server.exception.code.TaskErrorCode;
1414
import io.swagger.v3.oas.annotations.Operation;
15-
import io.swagger.v3.oas.annotations.media.Schema;
15+
import io.swagger.v3.oas.annotations.Parameter;
16+
import io.swagger.v3.oas.annotations.media.Content;
1617
import io.swagger.v3.oas.annotations.tags.Tag;
1718
import jakarta.validation.Valid;
1819
import jakarta.validation.constraints.NotNull;
@@ -43,8 +44,9 @@ public class ManagementTaskController {
4344
@PostMapping(consumes = {MediaType.MULTIPART_FORM_DATA_VALUE, MediaType.APPLICATION_JSON_VALUE})
4445
@Secured({"ROLE_MANAGER", "ROLE_USER"})
4546
public ResponseEntity<CreateTaskResponse> createTask(
47+
@Parameter(description = "작업 내용", content = @Content(mediaType = MediaType.APPLICATION_JSON_VALUE))
4648
@RequestPart(name = "taskInfo") @Valid CreateTaskRequest createTaskRequest,
47-
@Schema(description = "파일은 5개 이하만 업로드 가능합니다.")
49+
@Parameter(description = "파일은 5개 이하만 업로드 가능합니다.", content = @Content(mediaType = MediaType.MULTIPART_FORM_DATA_VALUE))
4850
@RequestPart(name = "attachment", required = false) List<MultipartFile> attachments,
4951
@AuthenticationPrincipal SecurityUserDetails userInfo
5052
) {
@@ -60,7 +62,7 @@ public ResponseEntity<CreateTaskResponse> createTask(
6062
public void updateTask(
6163
@PathVariable @NotNull Long taskId,
6264
@RequestPart(name = "taskInfo") @Valid UpdateTaskRequest updateTaskRequest,
63-
@Schema(description = "하나의 작업에는 총 5개 이하만 업로드 가능합니다.")
65+
@Parameter(description = "파일은 5개 이하만 업로드 가능합니다.", content = @Content(mediaType = MediaType.MULTIPART_FORM_DATA_VALUE))
6466
@RequestPart(name = "attachment", required = false) List<MultipartFile> attachments,
6567
@AuthenticationPrincipal SecurityUserDetails userInfo) {
6668
if (attachments != null && attachments.size() > 5) {

0 commit comments

Comments
 (0)