pricelees/roomescape-refactored
1
0
Fork 0
generated from pricelees/issue-pr-template
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: MemberAPI 인터페이스 응답 형식 수정 및 패키지 이동(web -> docs)

Browse Source
This commit is contained in:
이상진 2025-07-15 11:39:46 +09:00
parent cdb68c72c2
commit 2225527bd3
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/main/java/roomescape/member/web/MemberAPI.kt → src/main/java/roomescape/member/docs/MemberAPI.kt
View File

@ -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.Operation
import io.swagger.v3.oas.annotations.responses.ApiResponse import io.swagger.v3.oas.annotations.responses.ApiResponse
import io.swagger.v3.oas.annotations.responses.ApiResponses import io.swagger.v3.oas.annotations.responses.ApiResponses
import io.swagger.v3.oas.annotations.tags.Tag import io.swagger.v3.oas.annotations.tags.Tag
import org.springframework.http.HttpStatus import org.springframework.http.ResponseEntity
import org.springframework.web.bind.annotation.ResponseStatus
import roomescape.auth.web.support.Admin 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 = "회원 정보를 관리할 때 사용합니다.") @Tag(name = "2. 회원 API", description = "회원 정보를 관리할 때 사용합니다.")
interface MemberAPI { interface MemberAPI {
@Admin @Admin
@Operation(summary = "모든 회원 조회", tags = ["관리자 로그인이 필요한 API"]) @Operation(summary = "모든 회원 조회", tags = ["관리자 로그인이 필요한 API"])
@ApiResponses(ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true)) @ApiResponses(
@ResponseStatus(HttpStatus.OK) ApiResponse(
fun readAllMembers(): RoomescapeApiResponse<MembersResponse> responseCode = "200",
description = "성공",
useReturnTypeSchema = true
)
)
fun readAllMembers(): ResponseEntity<CommonApiResponse<MembersResponse>>
} }