refactor: DTO Schema 추가

Author: ys0221

src/main/java/com/back/web7_9_codecrete_be/domain/artists/dto/request/CreateRequest.java

@@ -1,23 +1,28 @@
 package com.back.web7_9_codecrete_be.domain.artists.dto.request;
 
 import com.back.web7_9_codecrete_be.domain.artists.entity.ArtistType;
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.NotNull;
 import jakarta.validation.constraints.Size;
 
 public record CreateRequest(
         @NotBlank(message = "아티스트 이름은 필수로 입력해야합니다.")
         @Size(max = 200, message = "아티스트 이름은 200자를 넘길 수 없습니다.")
+        @Schema(description = "아티스트 이름입니다.")
         String artistName,
 
         @Size(max = 150, message = "아티스트 그룹 이름은 150자를 넘길 수 없습니다.")
+        @Schema(description = "아티스트 소속 그룹입니다. 아티스트 이름이 그룹인 경우, null 로 처리됩니다.")
         String artistGroup,
 
         @NotNull(message = "아티스트 타입은 필수로 입력해야합니다(SOLO or GROUP)")
+        @Schema(description = "아티스트 타입입니다.", example = "SOLO or GROUP")
         ArtistType artistType,
 
         @NotBlank(message = "장르는 필수로 입력해야합니다.")
         @Size(max = 30, message = "장르는 30자를 넘길 수 없습니다.")
+        @Schema(description = "장르 이름입니다.")
         String genreName
 ) {
 }

src/main/java/com/back/web7_9_codecrete_be/domain/artists/dto/request/SearchRequest.java

@@ -1,11 +1,13 @@
 package com.back.web7_9_codecrete_be.domain.artists.dto.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.Size;
 
 public record SearchRequest(
         @NotBlank(message = "검색어를 입력해주세요")
         @Size(max = 200, message = "아티스트 이름은 200자를 넘길 수 없습니다.")
+        @Schema(description = "아티스트 이름입니다.")
         String artistName
 ) {
 }

src/main/java/com/back/web7_9_codecrete_be/domain/artists/dto/request/UpdateRequest.java

@@ -1,18 +1,23 @@
 package com.back.web7_9_codecrete_be.domain.artists.dto.request;
 
 import com.back.web7_9_codecrete_be.domain.artists.entity.ArtistType;
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.Size;
 
 public record UpdateRequest(
         @Size(max = 200, message = "아티스트 이름은 200자를 넘길 수 없습니다.")
+        @Schema(description = "아티스트 이름입니다.")
         String artistName,
 
         @Size(max = 150, message = "아티스트 그룹 이름은 150자를 넘길 수 없습니다.")
+        @Schema(description = "아티스트 소속 그룹입니다. 아티스트 이름이 그룹인 경우, null 로 처리됩니다.")
         String artistGroup,
 
+        @Schema(description = "아티스트 타입입니다.", example = "SOLO or GROUP")
         ArtistType artistType,
 
         @Size(max = 30, message = "장르 이름은 30자를 넘길 수 없습니다.")
+        @Schema(description = "장르 이름입니다.")
         String genreName
 ) {
 }

src/main/java/com/back/web7_9_codecrete_be/domain/artists/dto/response/AlbumResponse.java

@@ -1,10 +1,21 @@
 package com.back.web7_9_codecrete_be.domain.artists.dto.response;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+
 public record AlbumResponse(
+        @Schema(description = "앨범 이름입니다.")
         String albumName,
+
+        @Schema(description = "앨범 발매일입니다.", format = "yyyy-MM-dd")
         String releaseDate,
-        String albumType,       // album / single / ep
+
+        @Schema(description = "앨범 타입입니다.", example = "album or single or ep")
+        String albumType,
+
+        @Schema(description = "앨범 이미지 URL 입니다.")
         String imageUrl,
+
+        @Schema(description = "앨범 Spotify URL 입니다.")
         String spotifyUrl
 ) {
 }

src/main/java/com/back/web7_9_codecrete_be/domain/artists/dto/response/ArtistDetailResponse.java

@@ -1,20 +1,42 @@
 package com.back.web7_9_codecrete_be.domain.artists.dto.response;
 
 import com.back.web7_9_codecrete_be.domain.artists.entity.ArtistType;
+import io.swagger.v3.oas.annotations.media.Schema;
 
 import java.util.List;
 
 public record ArtistDetailResponse(
+        @Schema(description = "아티스트 이름입니다.")
         String artistName,
+
+        @Schema(description = "아티스트 소속 그룹입니다. 아티스트 이름이 그룹인 경우, null 로 처리됩니다.")
         String artistGroup,
+
+        @Schema(description = "아티스트 타입입니다.", example = "SOLO or GROUP")
         ArtistType artistType,
+
+        @Schema(description = "아티스트 프로필 이미지 URL 입니다.")
         String profileImageUrl,
+
+        @Schema(description = "받은 총 좋아요 수(찜한 수) 입니다.")
         long likeCount,
+
+        @Schema(description = "아티스트의 총 앨범 수 입니다.")
         int totalAlbums,
+
+        @Schema(description = "아티스트의 인기도 입니다.(Spotify 기준입니다.)")
         double popularityRating,
+
+        @Schema(description = "아티스트에 대한 설명입니다.")
         String description,
+
+        @Schema(description = "아티스트가 발매한 앨범 리스트입니다.")
         List<AlbumResponse> albums,
+
+        @Schema(description = "아티스트의 가장 인기 있는 트랙 상위 10개입니다.")
         List<TopTrackResponse> topTracks,
+
+        @Schema(description = "아티스트와 관련 있는 다른 아티스트 목록입니다.")
         List<RelatedArtistResponse> relatedArtists
 ) {
 }

src/main/java/com/back/web7_9_codecrete_be/domain/artists/dto/response/ArtistListResponse.java

@@ -1,10 +1,16 @@
 package com.back.web7_9_codecrete_be.domain.artists.dto.response;
 
 import com.back.web7_9_codecrete_be.domain.artists.entity.Artist;
+import io.swagger.v3.oas.annotations.media.Schema;
 
 public record ArtistListResponse(
+        @Schema(description = "아티스트 이름입니다.")
         String artistName,
+
+        @Schema(description = "아티스트 소속 그룹입니다. 아티스트 이름이 그룹인 경우, null 로 처리됩니다.")
         String artistGroup,
+
+        @Schema(description = "장르 이름입니다.")
         String genreName
 ) {
     public static ArtistListResponse from(Artist artist) {

src/main/java/com/back/web7_9_codecrete_be/domain/artists/dto/response/ConcertListByArtistResponse.java

@@ -1,12 +1,18 @@
 package com.back.web7_9_codecrete_be.domain.artists.dto.response;
 
 import com.back.web7_9_codecrete_be.domain.concerts.entity.Concert;
+import io.swagger.v3.oas.annotations.media.Schema;
 
 import java.time.LocalDate;
 
 public record ConcertListByArtistResponse(
+        @Schema(description = "공연명 입니다.")
         String concertName,
+
+        @Schema(description = "공연 시작 날짜입니다.", format = "yyyy-MM-dd")
         LocalDate startDate,
+
+        @Schema(description = "공연 장소입니다.")
         String concertPlace
 ) {
     public static ConcertListByArtistResponse from(Concert concert) {

src/main/java/com/back/web7_9_codecrete_be/domain/artists/dto/response/RelatedArtistResponse.java

@@ -1,8 +1,15 @@
 package com.back.web7_9_codecrete_be.domain.artists.dto.response;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+
 public record RelatedArtistResponse(
+        @Schema(description = "아티스트 이름입니다.")
         String artistName,
+
+        @Schema(description = "아티스트 사진 URL 입니다.")
         String imageUrl,
+
+        @Schema(description = "아티스트의 Spotify id 입니다.")
         String spotifyArtistId
 ) {
 }

src/main/java/com/back/web7_9_codecrete_be/domain/artists/dto/response/SearchResponse.java

@@ -1,10 +1,16 @@
 package com.back.web7_9_codecrete_be.domain.artists.dto.response;
 
 import com.back.web7_9_codecrete_be.domain.artists.entity.Artist;
+import io.swagger.v3.oas.annotations.media.Schema;
 
 public record SearchResponse(
+        @Schema(description = "아티스트 이름입니다.")
         String artistName,
+
+        @Schema(description = "아티스트 소속 그룹입니다. 아티스트 이름이 그룹인 경우, null 로 처리됩니다.")
         String artistGroup,
+
+        @Schema(description = "받은 총 좋아요 수(찜한 수) 입니다.")
         int likeCount
 ) {
     public static SearchResponse from(Artist artist) {

src/main/java/com/back/web7_9_codecrete_be/domain/artists/dto/response/TopTrackResponse.java

@@ -1,7 +1,12 @@
 package com.back.web7_9_codecrete_be.domain.artists.dto.response;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+
 public record TopTrackResponse(
+        @Schema(description = "노래 제목입니다.")
         String trackName,
+
+        @Schema(description = "노래의 Spotify URL 입니다.")
         String spotifyUrl
 ) {
 }