diff --git a/back/src/main/java/com/back/domain/mentoring/mentoring/controller/MentoringController.java b/back/src/main/java/com/back/domain/mentoring/mentoring/controller/MentoringController.java index c974c5b5..f6144ee2 100644 --- a/back/src/main/java/com/back/domain/mentoring/mentoring/controller/MentoringController.java +++ b/back/src/main/java/com/back/domain/mentoring/mentoring/controller/MentoringController.java @@ -8,6 +8,8 @@ import com.back.domain.mentoring.mentoring.service.MentoringService; import com.back.global.rq.Rq; import com.back.global.rsData.RsData; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.tags.Tag; import jakarta.validation.Valid; import lombok.RequiredArgsConstructor; import org.springframework.data.domain.Page; @@ -17,11 +19,13 @@ @RestController @RequestMapping("/mentoring") @RequiredArgsConstructor +@Tag(name = "MentoringController", description = "멘토링 API") public class MentoringController { private final MentoringService mentoringService; private final Rq rq; @GetMapping + @Operation(summary = "멘토링 목록 조회") public RsData getMentorings( @RequestParam(defaultValue = "0") int page, @RequestParam(defaultValue = "10") int size, @@ -38,6 +42,7 @@ public RsData getMentorings( } @GetMapping("/{mentoringId}") + @Operation(summary = "멘토링 상세 조회") public RsData getMentoring( @PathVariable Long mentoringId ) { @@ -52,6 +57,7 @@ public RsData getMentoring( @PostMapping @PreAuthorize("hasRole('MENTOR')") + @Operation(summary = "멘토링 생성") public RsData createMentoring( @RequestBody @Valid MentoringRequest reqDto ) { @@ -66,6 +72,7 @@ public RsData createMentoring( } @PutMapping("/{mentoringId}") + @Operation(summary = "멘토링 수정") public RsData updateMentoring( @PathVariable Long mentoringId, @RequestBody @Valid MentoringRequest reqDto @@ -81,6 +88,7 @@ public RsData updateMentoring( } @DeleteMapping("/{mentoringId}") + @Operation(summary = "멘토링 삭제") public RsData deleteMentoring( @PathVariable Long mentoringId ) { diff --git a/back/src/main/java/com/back/domain/mentoring/mentoring/dto/response/MentoringPagingResponse.java b/back/src/main/java/com/back/domain/mentoring/mentoring/dto/response/MentoringPagingResponse.java index 2ef9a059..8d5819f8 100644 --- a/back/src/main/java/com/back/domain/mentoring/mentoring/dto/response/MentoringPagingResponse.java +++ b/back/src/main/java/com/back/domain/mentoring/mentoring/dto/response/MentoringPagingResponse.java @@ -1,15 +1,21 @@ package com.back.domain.mentoring.mentoring.dto.response; import com.back.domain.mentoring.mentoring.dto.MentoringDto; +import io.swagger.v3.oas.annotations.media.Schema; import org.springframework.data.domain.Page; import java.util.List; public record MentoringPagingResponse( + @Schema(description = "멘토링 목록") List mentorings, + @Schema(description = "현재 페이지 (0부터 시작)") int currentPage, + @Schema(description = "총 페이지") int totalPage, + @Schema(description = "총 개수") long totalElements, + @Schema(description = "다음 페이지 존재 여부") boolean hasNext ) { public static MentoringPagingResponse from(Page page) { diff --git a/back/src/main/java/com/back/domain/mentoring/mentoring/dto/response/MentoringResponse.java b/back/src/main/java/com/back/domain/mentoring/mentoring/dto/response/MentoringResponse.java index 4805a330..56e9809b 100644 --- a/back/src/main/java/com/back/domain/mentoring/mentoring/dto/response/MentoringResponse.java +++ b/back/src/main/java/com/back/domain/mentoring/mentoring/dto/response/MentoringResponse.java @@ -2,9 +2,12 @@ import com.back.domain.member.mentor.dto.MentorDto; import com.back.domain.mentoring.mentoring.dto.MentoringDetailDto; +import io.swagger.v3.oas.annotations.media.Schema; public record MentoringResponse( + @Schema(description = "멘토링") MentoringDetailDto mentoring, + @Schema(description = "멘토") MentorDto mentor ) { } diff --git a/back/src/main/java/com/back/domain/mentoring/slot/controller/MentorSlotController.java b/back/src/main/java/com/back/domain/mentoring/slot/controller/MentorSlotController.java index 34047bf3..f3fce346 100644 --- a/back/src/main/java/com/back/domain/mentoring/slot/controller/MentorSlotController.java +++ b/back/src/main/java/com/back/domain/mentoring/slot/controller/MentorSlotController.java @@ -6,6 +6,8 @@ import com.back.domain.mentoring.slot.service.MentorSlotService; import com.back.global.rq.Rq; import com.back.global.rsData.RsData; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.tags.Tag; import jakarta.validation.Valid; import lombok.RequiredArgsConstructor; import org.springframework.security.access.prepost.PreAuthorize; @@ -14,6 +16,7 @@ @RestController @RequestMapping("/mentor-slot") @RequiredArgsConstructor +@Tag(name = "MentorSlotController", description = "멘토 슬롯(멘토의 예약 가능 일정) API") public class MentorSlotController { private final MentorSlotService mentorSlotService; @@ -21,6 +24,7 @@ public class MentorSlotController { @PostMapping @PreAuthorize("hasRole('MENTOR')") + @Operation(summary = "멘토 슬롯 생성") public RsData createMentorSlot( @RequestBody @Valid MentorSlotRequest reqDto ) { @@ -35,6 +39,7 @@ public RsData createMentorSlot( } @PutMapping("/{slotId}") + @Operation(summary = "멘토 슬롯 수정") public RsData updateMentorSlot( @PathVariable Long slotId, @RequestBody @Valid MentorSlotRequest reqDto