generated from pricelees/issue-pr-template
refactor: MemberAPI 인터페이스 응답 형식 수정 및 패키지 이동(web -> docs)
This commit is contained in:
parent
cdb68c72c2
commit
2225527bd3
@ -1,21 +1,24 @@
|
||||
package roomescape.member.web
|
||||
package roomescape.member.docs
|
||||
|
||||
import io.swagger.v3.oas.annotations.Operation
|
||||
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 org.springframework.http.HttpStatus
|
||||
import org.springframework.web.bind.annotation.ResponseStatus
|
||||
import org.springframework.http.ResponseEntity
|
||||
import roomescape.auth.web.support.Admin
|
||||
import roomescape.common.dto.response.RoomescapeApiResponse
|
||||
import roomescape.common.dto.response.CommonApiResponse
|
||||
import roomescape.member.web.MembersResponse
|
||||
|
||||
@Tag(name = "2. 회원 API", description = "회원 정보를 관리할 때 사용합니다.")
|
||||
interface MemberAPI {
|
||||
|
||||
@Admin
|
||||
@Operation(summary = "모든 회원 조회", tags = ["관리자 로그인이 필요한 API"])
|
||||
@ApiResponses(ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true))
|
||||
@ResponseStatus(HttpStatus.OK)
|
||||
fun readAllMembers(): RoomescapeApiResponse<MembersResponse>
|
||||
|
||||
@ApiResponses(
|
||||
ApiResponse(
|
||||
responseCode = "200",
|
||||
description = "성공",
|
||||
useReturnTypeSchema = true
|
||||
)
|
||||
)
|
||||
fun readAllMembers(): ResponseEntity<CommonApiResponse<MembersResponse>>
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user