generated from pricelees/issue-pr-template
pricelees
5fb5d2650b
<!-- 제목 양식 --> <!-- [이슈번호] 작업 요약 (예시: [#10] Gitea 템플릿 생성) --> ## 📝 관련 이슈 및 PR **PR과 관련된 이슈 번호** - #7 ## ✨ 작업 내용 <!-- 어떤 작업을 했는지 알려주세요! --> 1. 808c6675 에서 작업했던 정상 / 오류를 통합하는 객체를 사용하려 했으나, Swagger-UI상에서 응답 형식에 null 필드가 포함되는 문제로 다시 정상 / 오류 별도로 분리 2. Swagger-UI(문서화, 명세) 관련 코드는 인지하기 쉽도록 ../web -> ../docs 패키지로 이전 3. 현재까지 코틀린으로 마이그레이션 된 서비스를 대상으로, 응답에 ResponseEntity를 적용하고 \@ResponseStatus 제거 ## 🧪 테스트 <!-- 어떤 테스트를 생각했고 진행했는지 알려주세요! --> 예정으로는 Issue에 작성했던 테스트까지 처리하려고 했으나, 테스트는 바로 다음에 진행 예정 ## 📚 참고 자료 및 기타 <!-- 참고한 자료, 또는 논의할 사항이 있다면 알려주세요! --> Reviewed-on: #8 Co-authored-by: pricelees <priceelees@gmail.com> Co-committed-by: pricelees <priceelees@gmail.com>
102 lines
4.2 KiB
Java
102 lines
4.2 KiB
Java
package roomescape.theme.controller;
|
|
|
|
import org.springframework.http.HttpHeaders;
|
|
import org.springframework.http.HttpStatus;
|
|
import org.springframework.web.bind.annotation.DeleteMapping;
|
|
import org.springframework.web.bind.annotation.GetMapping;
|
|
import org.springframework.web.bind.annotation.PathVariable;
|
|
import org.springframework.web.bind.annotation.PostMapping;
|
|
import org.springframework.web.bind.annotation.RequestBody;
|
|
import org.springframework.web.bind.annotation.RequestParam;
|
|
import org.springframework.web.bind.annotation.ResponseStatus;
|
|
import org.springframework.web.bind.annotation.RestController;
|
|
|
|
import io.swagger.v3.oas.annotations.Operation;
|
|
import io.swagger.v3.oas.annotations.Parameter;
|
|
import io.swagger.v3.oas.annotations.media.Content;
|
|
import io.swagger.v3.oas.annotations.media.Schema;
|
|
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.servlet.http.HttpServletResponse;
|
|
import jakarta.validation.Valid;
|
|
import jakarta.validation.constraints.NotNull;
|
|
import roomescape.auth.web.support.Admin;
|
|
import roomescape.auth.web.support.LoginRequired;
|
|
import roomescape.common.dto.response.RoomescapeApiResponse;
|
|
import roomescape.common.dto.response.RoomescapeErrorResponse;
|
|
import roomescape.theme.dto.ThemeRequest;
|
|
import roomescape.theme.dto.ThemeResponse;
|
|
import roomescape.theme.dto.ThemesResponse;
|
|
import roomescape.theme.service.ThemeService;
|
|
|
|
@RestController
|
|
@Tag(name = "5. 테마 API", description = "테마를 조회 / 추가 / 삭제할 때 사용합니다.")
|
|
public class ThemeController {
|
|
|
|
private final ThemeService themeService;
|
|
|
|
public ThemeController(ThemeService themeService) {
|
|
this.themeService = themeService;
|
|
}
|
|
|
|
@LoginRequired
|
|
@GetMapping("/themes")
|
|
@ResponseStatus(HttpStatus.OK)
|
|
@Operation(summary = "모든 테마 조회", description = "모든 테마를 조회합니다.", tags = "로그인이 필요한 API")
|
|
@ApiResponses({
|
|
@ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true)
|
|
})
|
|
public RoomescapeApiResponse<ThemesResponse> getAllThemes() {
|
|
return RoomescapeApiResponse.success(themeService.findAllThemes());
|
|
}
|
|
|
|
@GetMapping("/themes/most-reserved-last-week")
|
|
@ResponseStatus(HttpStatus.OK)
|
|
@Operation(summary = "가장 많이 예약된 테마 조회")
|
|
@ApiResponses({
|
|
@ApiResponse(responseCode = "200", description = "성공", useReturnTypeSchema = true)
|
|
})
|
|
public RoomescapeApiResponse<ThemesResponse> getMostReservedThemes(
|
|
@RequestParam(defaultValue = "10") @Parameter(description = "최대로 조회할 테마 갯수") int count
|
|
) {
|
|
return RoomescapeApiResponse.success(themeService.getMostReservedThemesByCount(count));
|
|
}
|
|
|
|
@Admin
|
|
@PostMapping("/themes")
|
|
@ResponseStatus(HttpStatus.CREATED)
|
|
@Operation(summary = "테마 추가", tags = "관리자 로그인이 필요한 API")
|
|
@ApiResponses({
|
|
@ApiResponse(responseCode = "201", description = "성공", useReturnTypeSchema = true),
|
|
@ApiResponse(responseCode = "409", description = "같은 이름의 테마를 추가할 수 없습니다.",
|
|
content = @Content(schema = @Schema(implementation = RoomescapeErrorResponse.class)))
|
|
})
|
|
public RoomescapeApiResponse<ThemeResponse> saveTheme(
|
|
@Valid @RequestBody ThemeRequest request,
|
|
HttpServletResponse response
|
|
) {
|
|
ThemeResponse themeResponse = themeService.addTheme(request);
|
|
response.setHeader(HttpHeaders.LOCATION, "/themes/" + themeResponse.id());
|
|
|
|
return RoomescapeApiResponse.success(themeResponse);
|
|
}
|
|
|
|
@Admin
|
|
@DeleteMapping("/themes/{id}")
|
|
@ResponseStatus(HttpStatus.NO_CONTENT)
|
|
@Operation(summary = "테마 삭제", tags = "관리자 로그인이 필요한 API")
|
|
@ApiResponses({
|
|
@ApiResponse(responseCode = "204", description = "성공", useReturnTypeSchema = true),
|
|
@ApiResponse(responseCode = "409", description = "예약된 테마는 삭제할 수 없습니다.",
|
|
content = @Content(schema = @Schema(implementation = RoomescapeErrorResponse.class)))
|
|
})
|
|
public RoomescapeApiResponse<Void> removeTheme(
|
|
@NotNull(message = "themeId는 null일 수 없습니다.") @PathVariable Long id
|
|
) {
|
|
themeService.removeThemeById(id);
|
|
|
|
return RoomescapeApiResponse.success();
|
|
}
|
|
}
|