generated from pricelees/issue-pr-template
pricelees
ef903cf267
<!-- 제목 양식 --> <!-- [이슈번호] 작업 요약 (예시: [#10] Gitea 템플릿 생성) --> ## 📝 관련 이슈 및 PR **PR과 관련된 이슈 번호** - #22 ## ✨ 작업 내용 <!-- 어떤 작업을 했는지 알려주세요! --> - 기존 Thymeleaf 기반의 프론트엔드 코드를 React + Typescript 기반으로 마이그레이션 - 프론트엔드 분리에 따른 인증 API 수정 및 회원가입 API 추가 ## 🧪 테스트 <!-- 어떤 테스트를 생각했고 진행했는지 알려주세요! --> - 새로 추가된 API, 변경된 API 테스트 반영 ## 📚 참고 자료 및 기타 <!-- 참고한 자료, 또는 논의할 사항이 있다면 알려주세요! --> 프론트엔드 코드는 Gemini CLI가 구현하였고, API 관련 코드(ee21782ef9, frontend/src/api/**) 만 직접 구성 Reviewed-on: #23 Co-authored-by: pricelees <priceelees@gmail.com> Co-committed-by: pricelees <priceelees@gmail.com>
45 lines
1.8 KiB
Kotlin
45 lines
1.8 KiB
Kotlin
package roomescape.auth.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.RequestBody
|
|
import roomescape.auth.web.LoginCheckResponse
|
|
import roomescape.auth.web.LoginRequest
|
|
import roomescape.auth.web.LoginResponse
|
|
import roomescape.auth.web.support.MemberId
|
|
import roomescape.common.dto.response.CommonApiResponse
|
|
|
|
@Tag(name = "1. 인증 / 인가 API", description = "로그인, 로그아웃 및 로그인 상태를 확인합니다")
|
|
interface AuthAPI {
|
|
@Operation(summary = "로그인")
|
|
@ApiResponses(
|
|
ApiResponse(responseCode = "200", description = "로그인 성공시 토큰을 반환합니다."),
|
|
)
|
|
fun login(
|
|
@Valid @RequestBody loginRequest: LoginRequest
|
|
): ResponseEntity<CommonApiResponse<LoginResponse>>
|
|
|
|
@Operation(summary = "로그인 상태 확인")
|
|
@ApiResponses(
|
|
ApiResponse(
|
|
responseCode = "200",
|
|
description = "로그인 상태이며, 로그인된 회원의 이름 / 권한을 반환합니다.",
|
|
useReturnTypeSchema = true
|
|
),
|
|
)
|
|
fun checkLogin(
|
|
@MemberId @Parameter(hidden = true) memberId: Long
|
|
): ResponseEntity<CommonApiResponse<LoginCheckResponse>>
|
|
|
|
@Operation(summary = "로그아웃", tags = ["로그인이 필요한 API"])
|
|
@ApiResponses(
|
|
ApiResponse(responseCode = "200", description = "로그아웃 성공시 쿠키에 저장된 토큰 정보를 삭제합니다."),
|
|
)
|
|
fun logout(@MemberId memberId: Long): ResponseEntity<CommonApiResponse<Unit>>
|
|
}
|