-
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.
- Loading branch information
Showing
10 changed files
with
337 additions
and
19 deletions.
There are no files selected for viewing
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
144 changes: 144 additions & 0 deletions
144
dateroad-api/src/main/java/org/dateroad/advertisement/api/AdvertisementApi.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,144 @@ | ||
package org.dateroad.advertisement.api; | ||
|
||
import io.swagger.v3.oas.annotations.Operation; | ||
import io.swagger.v3.oas.annotations.Parameter; | ||
import io.swagger.v3.oas.annotations.media.Content; | ||
import io.swagger.v3.oas.annotations.media.ExampleObject; | ||
import io.swagger.v3.oas.annotations.media.Schema; | ||
import io.swagger.v3.oas.annotations.responses.ApiResponse; | ||
import io.swagger.v3.oas.annotations.security.SecurityRequirement; | ||
import io.swagger.v3.oas.annotations.tags.Tag; | ||
import org.dateroad.advertisement.dto.response.AdvGetAllRes; | ||
import org.dateroad.advertisement.dto.response.AdvGetDetailRes; | ||
import org.springframework.http.ResponseEntity; | ||
import org.springframework.web.bind.annotation.PathVariable; | ||
|
||
@Tag(name = "광고 관련 API") | ||
@SecurityRequirement(name = "Authorization") | ||
public interface AdvertisementApi { | ||
@Operation( | ||
summary = "광고 전체 조회 API", | ||
responses = { | ||
@ApiResponse( | ||
responseCode = "200", | ||
content = @Content( | ||
schema = @Schema(implementation = AdvGetAllRes.class), | ||
examples = @ExampleObject(value = """ | ||
{ | ||
"advertismentDtoResList": [ | ||
{ | ||
"advertismentId": 1, | ||
"thumbnail": "http://example.com/thumbnail1.jpg", | ||
"title": "광고 제목 1", | ||
}, | ||
{ | ||
"advertismentId": 2, | ||
"thumbnail": "http://example.com/thumbnail2.jpg", | ||
"title": "광고 제목 2", | ||
}, | ||
{ | ||
"advertismentId": 3, | ||
"thumbnail": "http://example.com/thumbnail2.jpg", | ||
"title": "광고 제목 3", | ||
}, | ||
{ | ||
"advertismentId": 4, | ||
"thumbnail": "http://example.com/thumbnail2.jpg", | ||
"title": "광고 제목 4", | ||
} | ||
] | ||
} | ||
""") | ||
), | ||
description = "요청이 성공했습니다." | ||
), | ||
@ApiResponse( | ||
responseCode = "400", | ||
description = "잘못된 요청입니다.", | ||
content = @Content), | ||
@ApiResponse( | ||
responseCode = "401", | ||
description = "액세스 토큰의 형식이 올바르지 않습니다. Bearer 타입을 확인해 주세요.", | ||
content = @Content), | ||
@ApiResponse( | ||
responseCode = "401", | ||
description = "액세스 토큰의 값이 올바르지 않습니다.", | ||
content = @Content), | ||
@ApiResponse( | ||
responseCode = "401", | ||
description = "액세스 토큰이 만료되었습니다. 재발급 받아주세요.", | ||
content = @Content), | ||
@ApiResponse( | ||
responseCode = "405", | ||
description = "잘못된 HTTP method 요청입니다.", | ||
content = @Content), | ||
@ApiResponse( | ||
responseCode = "500", | ||
description = "서버 내부 오류입니다.", | ||
content = @Content)}) | ||
ResponseEntity<AdvGetAllRes> getAllAdvertisements(); | ||
|
||
@Operation( | ||
summary = "광고 상세 조회 API", | ||
responses = { | ||
@ApiResponse( | ||
responseCode = "200", | ||
content = @Content( | ||
schema = @Schema(implementation = AdvGetDetailRes.class), | ||
examples = @ExampleObject(value = """ | ||
{ | ||
"images": [ | ||
{ | ||
"imagesUrl": "http://example.com/image1.jpg", | ||
"sequence": 1 | ||
}, | ||
{ | ||
"imagesUrl": "http://example.com/image2.jpg", | ||
"sequence": 2 | ||
} | ||
], | ||
"title": "광고 제목", | ||
"createAt": "2023.07.14", | ||
"description": "광고 설명" | ||
} | ||
""") | ||
), | ||
description = "요청이 성공했습니다." | ||
), | ||
@ApiResponse( | ||
responseCode = "400", | ||
description = "잘못된 요청입니다.", | ||
content = @Content), | ||
@ApiResponse( | ||
responseCode = "400", | ||
description = "유효하지 않은 요청 파라미터 값입니다.", | ||
content = @Content), | ||
@ApiResponse( | ||
responseCode = "401", | ||
description = "액세스 토큰의 형식이 올바르지 않습니다. Bearer 타입을 확인해 주세요.", | ||
content = @Content), | ||
@ApiResponse( | ||
responseCode = "401", | ||
description = "액세스 토큰의 값이 올바르지 않습니다.", | ||
content = @Content), | ||
@ApiResponse( | ||
responseCode = "401", | ||
description = "액세스 토큰이 만료되었습니다. 재발급 받아주세요.", | ||
content = @Content), | ||
|
||
@ApiResponse( | ||
responseCode = "404", | ||
description = "존재하지 않는 광고입니다.", | ||
content = @Content), | ||
@ApiResponse( | ||
responseCode = "405", | ||
description = "잘못된 HTTP method 요청입니다.", | ||
content = @Content), | ||
@ApiResponse( | ||
responseCode = "500", | ||
description = "서버 내부 오류입니다.", | ||
content = @Content)}) | ||
ResponseEntity<AdvGetDetailRes> getAdvertisementsDetail( | ||
@Parameter(required = true) final @PathVariable Long advId | ||
); | ||
} |
88 changes: 88 additions & 0 deletions
88
dateroad-api/src/main/java/org/dateroad/point/api/PointApi.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,88 @@ | ||
package org.dateroad.point.api; | ||
|
||
import io.swagger.v3.oas.annotations.Operation; | ||
import io.swagger.v3.oas.annotations.Parameter; | ||
import io.swagger.v3.oas.annotations.media.Content; | ||
import io.swagger.v3.oas.annotations.media.ExampleObject; | ||
import io.swagger.v3.oas.annotations.media.Schema; | ||
import io.swagger.v3.oas.annotations.responses.ApiResponse; | ||
import io.swagger.v3.oas.annotations.security.SecurityRequirement; | ||
import io.swagger.v3.oas.annotations.tags.Tag; | ||
import org.dateroad.auth.argumentresolve.UserId; | ||
import org.dateroad.point.dto.response.PointGetAllRes; | ||
import org.springframework.http.ResponseEntity; | ||
|
||
@Tag(name = "포인트 관련 API") | ||
@SecurityRequirement(name = "Authorization") | ||
public interface PointApi { | ||
@Operation( | ||
summary = "포인트 내역 조회 API", | ||
responses = { | ||
@ApiResponse( | ||
responseCode = "200", | ||
content = @Content( | ||
schema = @Schema(implementation = PointGetAllRes.class), | ||
examples = @ExampleObject(value = """ | ||
{ | ||
"gained": { | ||
"points": [ | ||
{ | ||
"point": 100, | ||
"description": "첫 구매 적립", | ||
"createdAt": "2023.07.14" | ||
}, | ||
{ | ||
"point": 200, | ||
"description": "리뷰 작성 적립", | ||
"createdAt": "2023.07.15" | ||
} | ||
] | ||
}, | ||
"used": { | ||
"points": [ | ||
{ | ||
"point": 50, | ||
"description": "구매 사용", | ||
"createdAt": "2023.07.16" | ||
}, | ||
{ | ||
"point": 80, | ||
"description": "이벤트 참여 사용", | ||
"createdAt": "2023.07.17" | ||
} | ||
] | ||
} | ||
} | ||
""") | ||
), | ||
description = "요청이 성공했습니다." | ||
), | ||
@ApiResponse( | ||
responseCode = "400", | ||
description = "잘못된 요청입니다.", | ||
content = @Content), | ||
@ApiResponse( | ||
responseCode = "401", | ||
description = "액세스 토큰의 형식이 올바르지 않습니다. Bearer 타입을 확인해 주세요.", | ||
content = @Content), | ||
@ApiResponse( | ||
responseCode = "401", | ||
description = "액세스 토큰의 값이 올바르지 않습니다.", | ||
content = @Content), | ||
@ApiResponse( | ||
responseCode = "401", | ||
description = "액세스 토큰이 만료되었습니다. 재발급 받아주세요.", | ||
content = @Content), | ||
@ApiResponse( | ||
responseCode = "405", | ||
description = "잘못된 HTTP method 요청입니다.", | ||
content = @Content), | ||
@ApiResponse( | ||
responseCode = "500", | ||
description = "서버 내부 오류입니다.", | ||
content = @Content)}) | ||
public ResponseEntity<PointGetAllRes> getAllPoints( | ||
@Parameter(required = true) | ||
@UserId Long userId | ||
); | ||
} |
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
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
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
Oops, something went wrong.