-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
feat: 포토(앨범) 도메인 API 모킹하기
- Loading branch information
Showing
12 changed files
with
293 additions
and
0 deletions.
There are no files selected for viewing
46 changes: 46 additions & 0 deletions
46
photo-service/src/main/java/kr/mafoo/photo/api/AlbumApi.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
package kr.mafoo.photo.api; | ||
|
||
import io.swagger.v3.oas.annotations.Operation; | ||
import io.swagger.v3.oas.annotations.Parameter; | ||
import io.swagger.v3.oas.annotations.tags.Tag; | ||
import kr.mafoo.photo.controller.dto.request.AlbumCreateRequest; | ||
import kr.mafoo.photo.controller.dto.request.AlbumUpdateRequest; | ||
import kr.mafoo.photo.controller.dto.response.AlbumResponse; | ||
import org.springframework.web.bind.annotation.*; | ||
import reactor.core.publisher.Flux; | ||
import reactor.core.publisher.Mono; | ||
|
||
@Tag(name = "앨범 관련 API", description = "앨범 조회, 생성, 수정, 삭제 등 API") | ||
@RequestMapping("/v1/albums") | ||
public interface AlbumApi { | ||
@Operation(summary = "앨범 조회", description = "앨범 목록을 조회합니다.") | ||
@GetMapping | ||
Flux<AlbumResponse> getAlbums( | ||
); | ||
|
||
@Operation(summary = "앨범 생성", description = "앨범을 생성합니다.") | ||
@PostMapping | ||
Mono<AlbumResponse> createAlbum( | ||
@RequestBody | ||
AlbumCreateRequest request | ||
); | ||
|
||
@Operation(summary = "앨범 수정", description = "앨범의 이름 및 종류를 수정합니다.") | ||
@PutMapping("/{albumId}") | ||
Mono<AlbumResponse> updateAlbum( | ||
@Parameter(description = "앨범 ID", example = "test_album_id") | ||
@PathVariable | ||
String albumId, | ||
|
||
@RequestBody | ||
AlbumUpdateRequest request | ||
); | ||
|
||
@Operation(summary = "앨범 삭제", description = "앨범을 삭제합니다.") | ||
@DeleteMapping("/{albumId}") | ||
Mono<Void> deleteAlbum( | ||
@Parameter(description = "앨범 ID", example = "test_album_id") | ||
@PathVariable | ||
String albumId | ||
); | ||
} |
49 changes: 49 additions & 0 deletions
49
photo-service/src/main/java/kr/mafoo/photo/api/PhotoApi.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
package kr.mafoo.photo.api; | ||
|
||
import io.swagger.v3.oas.annotations.Operation; | ||
import io.swagger.v3.oas.annotations.Parameter; | ||
import io.swagger.v3.oas.annotations.tags.Tag; | ||
import kr.mafoo.photo.controller.dto.request.PhotoCreateRequest; | ||
import kr.mafoo.photo.controller.dto.request.PhotoAlbumUpdateRequest; | ||
import kr.mafoo.photo.controller.dto.response.PhotoResponse; | ||
import org.springframework.web.bind.annotation.*; | ||
import reactor.core.publisher.Flux; | ||
import reactor.core.publisher.Mono; | ||
|
||
@Tag(name = "사진 관련 API", description = "사진 조회, 생성, 수정, 삭제 등 API") | ||
@RequestMapping("/v1/photos") | ||
public interface PhotoApi { | ||
@Operation(summary = "사진 조회", description = "사진 목록을 조회합니다.") | ||
@GetMapping | ||
Flux<PhotoResponse> getAlbumPhotos( | ||
@Parameter(description = "앨범 ID", example = "test_album_id") | ||
@RequestParam(required = false) | ||
String albumId | ||
); | ||
|
||
@Operation(summary = "사진 생성", description = "사진을 생성합니다.") | ||
@PostMapping | ||
Mono<PhotoResponse> createPhoto( | ||
@RequestBody | ||
PhotoCreateRequest request | ||
); | ||
|
||
@Operation(summary = "사진 앨범 수정", description = "사진을 다른 앨범으로 이동시킵니다.") | ||
@PatchMapping("/{photoId}/album") | ||
Mono<PhotoResponse> updatePhotoAlbum( | ||
@Parameter(description = "사진 ID", example = "test_photo_id") | ||
@PathVariable | ||
String photoId, | ||
|
||
@RequestBody | ||
PhotoAlbumUpdateRequest request | ||
); | ||
|
||
@Operation(summary = "사진 삭제", description = "사진을 삭제합니다.") | ||
@DeleteMapping("{photoId}") | ||
Mono<Void> deletePhoto( | ||
@Parameter(description = "사진 ID", example = "test_photo_id") | ||
@PathVariable | ||
String photoId | ||
); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 55 additions & 0 deletions
55
photo-service/src/main/java/kr/mafoo/photo/controller/AlbumController.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
package kr.mafoo.photo.controller; | ||
|
||
import kr.mafoo.photo.api.AlbumApi; | ||
import kr.mafoo.photo.controller.dto.request.AlbumCreateRequest; | ||
import kr.mafoo.photo.controller.dto.request.AlbumUpdateRequest; | ||
import kr.mafoo.photo.controller.dto.response.AlbumResponse; | ||
import org.springframework.web.bind.annotation.*; | ||
import reactor.core.publisher.Flux; | ||
import reactor.core.publisher.Mono; | ||
|
||
import static kr.mafoo.photo.domain.AlbumType.*; | ||
|
||
@RestController | ||
public class AlbumController implements AlbumApi { | ||
|
||
@Override | ||
public Flux<AlbumResponse> getAlbums( | ||
) { | ||
return Flux.just( | ||
new AlbumResponse("test_album_id_a", "단짝이랑", TYPE_A, "1"), | ||
new AlbumResponse("test_album_id_b", "야뿌들", TYPE_B, "5"), | ||
new AlbumResponse("test_album_id_c", "농구팟", TYPE_C, "2"), | ||
new AlbumResponse("test_album_id_d", "화사사람들", TYPE_D, "12"), | ||
new AlbumResponse("test_album_id_e", "기념일", TYPE_E, "4"), | ||
new AlbumResponse("test_album_id_f", "친구들이랑", TYPE_F, "9") | ||
); | ||
} | ||
|
||
@Override | ||
public Mono<AlbumResponse> createAlbum( | ||
AlbumCreateRequest request | ||
){ | ||
return Mono.just( | ||
new AlbumResponse("test_album_id", "시금치파슷하", TYPE_A, "0") | ||
); | ||
} | ||
|
||
@Override | ||
public Mono<AlbumResponse> updateAlbum( | ||
String albumId, | ||
AlbumUpdateRequest request | ||
){ | ||
return Mono.just( | ||
new AlbumResponse("test_album_id", "시금치파슷하", TYPE_A, "0") | ||
); | ||
} | ||
|
||
@Override | ||
public Mono<Void> deleteAlbum( | ||
String albumId | ||
){ | ||
return Mono.empty(); | ||
} | ||
|
||
} |
50 changes: 50 additions & 0 deletions
50
photo-service/src/main/java/kr/mafoo/photo/controller/PhotoController.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
package kr.mafoo.photo.controller; | ||
|
||
import kr.mafoo.photo.api.PhotoApi; | ||
import kr.mafoo.photo.controller.dto.request.PhotoCreateRequest; | ||
import kr.mafoo.photo.controller.dto.request.PhotoAlbumUpdateRequest; | ||
import kr.mafoo.photo.controller.dto.response.PhotoResponse; | ||
import org.springframework.web.bind.annotation.RestController; | ||
import reactor.core.publisher.Flux; | ||
import reactor.core.publisher.Mono; | ||
|
||
@RestController | ||
public class PhotoController implements PhotoApi { | ||
|
||
@Override | ||
public Flux<PhotoResponse> getAlbumPhotos( | ||
String albumId | ||
){ | ||
return Flux.just( | ||
new PhotoResponse("test_photo_id_a", "test_album_id_a", "photo_url"), | ||
new PhotoResponse("test_photo_id_b", "test_album_id_a", "photo_url"), | ||
new PhotoResponse("test_photo_id_c", "test_album_id_a", "photo_url") | ||
); | ||
} | ||
|
||
@Override | ||
public Mono<PhotoResponse> createPhoto( | ||
PhotoCreateRequest request | ||
){ | ||
return Mono.just( | ||
new PhotoResponse("test_photo_id", "photo_url", null) | ||
); | ||
} | ||
|
||
@Override | ||
public Mono<PhotoResponse> updatePhotoAlbum( | ||
String photoId, | ||
PhotoAlbumUpdateRequest request | ||
){ | ||
return Mono.just( | ||
new PhotoResponse("test_photo_id", "photo_url", "test_album_id") | ||
); | ||
} | ||
|
||
@Override | ||
public Mono<Void> deletePhoto( | ||
String photoId | ||
){ | ||
return Mono.empty(); | ||
} | ||
} |
13 changes: 13 additions & 0 deletions
13
photo-service/src/main/java/kr/mafoo/photo/controller/dto/request/AlbumCreateRequest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
package kr.mafoo.photo.controller.dto.request; | ||
|
||
import io.swagger.v3.oas.annotations.media.Schema; | ||
|
||
@Schema(description = "앨범 생성 요청") | ||
public record AlbumCreateRequest( | ||
@Schema(description = "앨범 이름", example = "시금치파슷하") | ||
String name, | ||
|
||
@Schema(description = "앨범 타입", example = "TYPE_A") | ||
String type | ||
) { | ||
} |
13 changes: 13 additions & 0 deletions
13
photo-service/src/main/java/kr/mafoo/photo/controller/dto/request/AlbumUpdateRequest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
package kr.mafoo.photo.controller.dto.request; | ||
|
||
import io.swagger.v3.oas.annotations.media.Schema; | ||
|
||
@Schema(description = "앨범 수정 요청") | ||
public record AlbumUpdateRequest( | ||
@Schema(description = "앨범 이름", example = "시금치파슷하") | ||
String name, | ||
|
||
@Schema(description = "앨범 타입", example = "TYPE_A") | ||
String type | ||
) { | ||
} |
10 changes: 10 additions & 0 deletions
10
...-service/src/main/java/kr/mafoo/photo/controller/dto/request/PhotoAlbumUpdateRequest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
package kr.mafoo.photo.controller.dto.request; | ||
|
||
import io.swagger.v3.oas.annotations.media.Schema; | ||
|
||
@Schema(description = "사진 앨범 수정 요청") | ||
public record PhotoAlbumUpdateRequest( | ||
@Schema(description = "앨범 ID", example = "test_album_id") | ||
String albumId | ||
) { | ||
} |
10 changes: 10 additions & 0 deletions
10
photo-service/src/main/java/kr/mafoo/photo/controller/dto/request/PhotoCreateRequest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
package kr.mafoo.photo.controller.dto.request; | ||
|
||
import io.swagger.v3.oas.annotations.media.Schema; | ||
|
||
@Schema(description = "사진 생성 요청") | ||
public record PhotoCreateRequest( | ||
@Schema(description = "QR URL", example = "qr_url") | ||
String qrUrl | ||
) { | ||
} |
20 changes: 20 additions & 0 deletions
20
photo-service/src/main/java/kr/mafoo/photo/controller/dto/response/AlbumResponse.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
package kr.mafoo.photo.controller.dto.response; | ||
|
||
import io.swagger.v3.oas.annotations.media.Schema; | ||
import kr.mafoo.photo.domain.AlbumType; | ||
|
||
@Schema(description = "앨범 응답") | ||
public record AlbumResponse( | ||
@Schema(description = "앨범 ID", example = "test_album_id") | ||
String albumId, | ||
|
||
@Schema(description = "앨범 이름", example = "야뿌들") | ||
String name, | ||
|
||
@Schema(description = "앨범 종류", example = "TYPE_B") | ||
AlbumType type, | ||
|
||
@Schema(description = "앨범 내 사진 수", example = "6") | ||
String photoCount | ||
) { | ||
} |
16 changes: 16 additions & 0 deletions
16
photo-service/src/main/java/kr/mafoo/photo/controller/dto/response/PhotoResponse.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
package kr.mafoo.photo.controller.dto.response; | ||
|
||
import io.swagger.v3.oas.annotations.media.Schema; | ||
|
||
@Schema(description = "사진 응답") | ||
public record PhotoResponse( | ||
@Schema(description = "사진 ID", example = "test_photo_id") | ||
String photoId, | ||
|
||
@Schema(description = "사진 URL", example = "photo_url") | ||
String photoUrl, | ||
|
||
@Schema(description = "앨범 ID", example = "test_album_id") | ||
String albumId | ||
) { | ||
} |
10 changes: 10 additions & 0 deletions
10
photo-service/src/main/java/kr/mafoo/photo/domain/AlbumType.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
package kr.mafoo.photo.domain; | ||
|
||
public enum AlbumType { | ||
TYPE_A, | ||
TYPE_B, | ||
TYPE_C, | ||
TYPE_D, | ||
TYPE_E, | ||
TYPE_F, | ||
} |