generated from pricelees/issue-pr-template
52 lines
2.3 KiB
Kotlin
52 lines
2.3 KiB
Kotlin
package roomescape.theme.docs
|
|
|
|
import io.swagger.v3.oas.annotations.Operation
|
|
import io.swagger.v3.oas.annotations.Parameter
|
|
import io.swagger.v3.oas.annotations.responses.ApiResponse
|
|
import io.swagger.v3.oas.annotations.responses.ApiResponses
|
|
import io.swagger.v3.oas.annotations.tags.Tag
|
|
import jakarta.validation.Valid
|
|
import org.springframework.http.ResponseEntity
|
|
import org.springframework.web.bind.annotation.PathVariable
|
|
import org.springframework.web.bind.annotation.RequestBody
|
|
import org.springframework.web.bind.annotation.RequestParam
|
|
import roomescape.auth.web.support.Admin
|
|
import roomescape.auth.web.support.LoginRequired
|
|
import roomescape.common.dto.response.CommonApiResponse
|
|
import roomescape.theme.web.ThemeCreateRequest
|
|
import roomescape.theme.web.ThemeRetrieveListResponse
|
|
import roomescape.theme.web.ThemeRetrieveResponse
|
|
|
|
@Tag(name = "5. 테마 API", description = "테마를 조회 / 추가 / 삭제할 때 사용합니다.")
|
|
interface ThemeAPI {
|
|
|
|
@LoginRequired
|
|
@Operation(summary = "모든 테마 조회", description = "모든 테마를 조회합니다.", tags = ["로그인이 필요한 API"])
|
|
@ApiResponses(ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true))
|
|
fun findThemes(): ResponseEntity<CommonApiResponse<ThemeRetrieveListResponse>>
|
|
|
|
@Operation(summary = "가장 많이 예약된 테마 조회")
|
|
@ApiResponses(ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true))
|
|
fun findMostReservedThemes(
|
|
@RequestParam(defaultValue = "10") @Parameter(description = "최대로 조회할 테마 갯수") count: Int
|
|
): ResponseEntity<CommonApiResponse<ThemeRetrieveListResponse>>
|
|
|
|
@Admin
|
|
@Operation(summary = "테마 추가", tags = ["관리자 로그인이 필요한 API"])
|
|
@ApiResponses(
|
|
ApiResponse(responseCode = "201", description = "성공", useReturnTypeSchema = true),
|
|
)
|
|
fun createTheme(
|
|
@Valid @RequestBody request: ThemeCreateRequest,
|
|
): ResponseEntity<CommonApiResponse<ThemeRetrieveResponse>>
|
|
|
|
@Admin
|
|
@Operation(summary = "테마 삭제", tags = ["관리자 로그인이 필요한 API"])
|
|
@ApiResponses(
|
|
ApiResponse(responseCode = "204", description = "성공", useReturnTypeSchema = true),
|
|
)
|
|
fun deleteTheme(
|
|
@PathVariable id: Long
|
|
): ResponseEntity<CommonApiResponse<Unit>>
|
|
}
|