generated from pricelees/issue-pr-template
37 lines
1.6 KiB
Kotlin
37 lines
1.6 KiB
Kotlin
package roomescape.region.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 org.springframework.http.ResponseEntity
|
|
import org.springframework.web.bind.annotation.RequestParam
|
|
import roomescape.auth.web.support.Public
|
|
import roomescape.common.dto.response.CommonApiResponse
|
|
import roomescape.region.infrastructure.web.DongListResponse
|
|
import roomescape.region.infrastructure.web.RegionCodeResponse
|
|
import roomescape.region.infrastructure.web.SidoListResponse
|
|
import roomescape.region.infrastructure.web.SigunguListResponse
|
|
|
|
interface RegionAPI {
|
|
|
|
@Public
|
|
@Operation(summary = "지역 코드 조회")
|
|
@ApiResponses(ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true))
|
|
fun findRegionCode(
|
|
@RequestParam(name = "sidoCode", required = true) sidoCode: String,
|
|
@RequestParam(name = "sigunguCode", required = true) sigunguCode: String,
|
|
): ResponseEntity<CommonApiResponse<RegionCodeResponse>>
|
|
|
|
@Public
|
|
@Operation(summary = "모든 시 / 도 목록 조회")
|
|
@ApiResponses(ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true))
|
|
fun readAllSido(): ResponseEntity<CommonApiResponse<SidoListResponse>>
|
|
|
|
@Public
|
|
@Operation(summary = "모든 시 / 군 / 구 목록 조회")
|
|
@ApiResponses(ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true))
|
|
fun findAllSigunguBySido(
|
|
@RequestParam(required = true) sidoCode: String
|
|
): ResponseEntity<CommonApiResponse<SigunguListResponse>>
|
|
}
|