Feat: 백오피스 개발

README.md

@@ -204,6 +204,10 @@ soft delete 적용 과정은 [Soft Delete 방식 적용](https://github.com/ODOI
 - [JWT 예외처리](https://odoichon.github.io/server/src/main/resources/static/docs/jwt.html)
 - [좋아요 API 명세서](https://odoichon.github.io/server/src/main/resources/static/docs/love.html)
 - [ErrorCode 명세서](https://odoichon.github.io/server/src/main/resources/static/docs/error.html)
+- [레코드 API 명세서](https://odoichon.github.io/server/src/main/resources/static/docs/record.html)
+- [레코드 카테고리 API 명세서](https://odoichon.github.io/server/src/main/resources/static/docs/record_category.html)
+- [레코드 댓글 API 명세서](https://odoichon.github.io/server/src/main/resources/static/docs/record_comment.html)
+- [레코드 리뷰 API 명세서](https://odoichon.github.io/server/src/main/resources/static/docs/record_review.html)
 <br/>
 
 ### 기타 회고 및 문서화

src/docs/asciidoc/record.adoc

@@ -0,0 +1,119 @@
+== Record API
+
+=== 1. 레코드 저장
+----
+part
+
+web, server, infra, all
+----
+----
+type - category
+
+odori - culture
+retro - retrospection
+tech - disaster
+tech - issue
+tech - new_tech
+tech - architecture
+----
+===== Request
+include::{snippets}/save-record/http-request.adoc[]
+===== Response - Success
+include::{snippets}/save-record/http-response.adoc[]
+
+=== 2. 레코드 수정
+===== Request
+include::{snippets}/update-record/http-request.adoc[]
+===== Response - Success
+include::{snippets}/update-record/http-response.adoc[]
+
+=== 3. 레코드 삭제
+===== Request
+include::{snippets}/delete-record/http-request.adoc[]
+===== Response - Success
+include::{snippets}/delete-record/http-response.adoc[]
+
+=== 4. 핫 레코드 목록 조회
+===== Request
+include::{snippets}/get-hot-records/http-request.adoc[]
+===== Response - Success
+include::{snippets}/get-hot-records/http-response.adoc[]
+
+=== 5. 레코드 목록 조회
+----
+/api/v1/record/{part}/{type}?category=&page=
+----
+----
+part
+
+web, server, infra, all
+----
+----
+type - category
+
+odori - culture
+retro - retrospection
+tech - disaster
+tech - issue
+tech - new_tech
+tech - architecture
+all - x
+----
+----
+page : 레코드 목록 페이지 번호 (0부터 1페이지)
+----
+===== Request
+include::{snippets}/get-records/http-request.adoc[]
+===== Response - Success
+include::{snippets}/get-records/http-response.adoc[]
+
+=== 6. 레코드 조회
+----
+page : 댓글 목록 페이지 번호 (0부터 1페이지)
+----
+----
+level : 댓글 / 대댓글 / 대대댓글 구분 (1 - 댓글, 2 - 대댓글 ...)
+----
+===== Request
+include::{snippets}/get-record/http-request.adoc[]
+===== Response - Success
+include::{snippets}/get-record/http-response.adoc[]
+
+=== 7. 레코드 조회 - 리뷰
+----
+reviews : 리뷰 댓글
+reviews.status : 리뷰 상태 (approve - 승인, reject - 반려, mine - 레코드 작성자)
+reviewers : 리뷰 신청자 (approve - 승인, reject - 반려, wait - 대기)
+----
+===== Request
+include::{snippets}/get-record-with-review/http-request.adoc[]
+===== Response - Success
+include::{snippets}/get-record-with-review/http-response.adoc[]
+
+=== 8. 레코드 목록 조회 - 리뷰 받는 사람
+----
+page : 레코드 목록 페이지 번호 (0부터 1페이지)
+
+status
+wait : 내가 작성한 글 중 대기상태인 글
+approve : 내가 작성한 글 중 승인 처리된 글
+reject : 내가 작성한 글 중 반려 처리된 글
+----
+===== Request
+include::{snippets}/get-reviewee-records/http-request.adoc[]
+===== Response - Success
+include::{snippets}/get-reviewee-records/http-response.adoc[]
+
+=== 9. 레코드 목록 조회 - 리뷰 하는 사람
+----
+page : 레코드 목록 페이지 번호 (0부터 1페이지)
+
+status
+wait : 내가 아직 리뷰하지 않은 글
+approve : 내가 승인 처리한 글
+reject : 내가 반려 처리한 글
+----
+===== Request
+include::{snippets}/get-reviewer-records/http-request.adoc[]
+===== Response - Success
+include::{snippets}/get-reviewer-records/http-response.adoc[]

src/docs/asciidoc/record_category.adoc

@@ -0,0 +1,24 @@
+== Record Category API
+
+----
+category
+
+culture (오도리 - 팀 내 문화)
+retrospection (회고 - 회고)
+disaster (기술 - 장애 관리)
+issue (기술 - 이슈 관리)
+new_tech (기술 - 신 기술)
+architecture (기술 - 설계)
+----
+
+=== 1. 템플릿 저장
+===== Request
+include::{snippets}/update-template/http-request.adoc[]
+===== Response
+include::{snippets}/update-template/http-response.adoc[]
+
+=== 2. 템플릿 조회
+===== Request
+include::{snippets}/get-template/http-request.adoc[]
+===== Response
+include::{snippets}/get-template/http-response.adoc[]

src/docs/asciidoc/record_comment.adoc

@@ -0,0 +1,23 @@
+== Record Comment API
+
+----
+parent_id : 부모 댓글 아이디
+----
+
+=== 1. 댓글 저장
+===== Request
+include::{snippets}/save-record-comment/http-request.adoc[]
+===== Response
+include::{snippets}/save-record-comment/http-response.adoc[]
+
+=== 2. 댓글 수정
+===== Request
+include::{snippets}/update-record-comment/http-request.adoc[]
+===== Response
+include::{snippets}/update-record-comment/http-response.adoc[]
+
+=== 3. 댓글 삭제
+===== Request
+include::{snippets}/delete-record-comment/http-request.adoc[]
+===== Response
+include::{snippets}/delete-record-comment/http-response.adoc[]

src/docs/asciidoc/record_review.adoc

@@ -0,0 +1,33 @@
+== Record Review API
+
+----
+status
+
+approve (승인)
+reject (반려)
+mine (레코드 작성자가 리뷰를 달 때)
+----
+
+=== 1. 리뷰 저장
+===== Request
+include::{snippets}/save-record-review/http-request.adoc[]
+===== Response - Success
+include::{snippets}/save-record-review/http-response.adoc[]
+===== Response - Fail
+include::{snippets}/save-record-review-exception/http-response.adoc[]
+
+=== 2. 리뷰 수정
+===== Request
+include::{snippets}/update-record-review/http-request.adoc[]
+===== Response - Success
+include::{snippets}/update-record-review/http-response.adoc[]
+===== Response - Fail
+include::{snippets}/update-record-review-exception/http-response.adoc[]
+
+=== 3. 리뷰 삭제
+===== Request
+include::{snippets}/delete-record-review/http-request.adoc[]
+===== Response - Success
+include::{snippets}/delete-record-review/http-response.adoc[]
+===== Response - Fail
+include::{snippets}/delete-record-review-exception/http-response.adoc[]

src/main/kotlin/com/example/jhouse_server/JhouseServerApplication.kt

@@ -2,8 +2,10 @@ package com.example.jhouse_server
 
 import org.springframework.boot.autoconfigure.SpringBootApplication
 import org.springframework.boot.runApplication
+import org.springframework.scheduling.annotation.EnableScheduling
 
 
+@EnableScheduling
 @SpringBootApplication
 class JhouseServerApplication
 

src/main/kotlin/com/example/jhouse_server/domain/record/controller/RecordController.kt

@@ -0,0 +1,112 @@
+package com.example.jhouse_server.domain.record.controller
+
+import com.example.jhouse_server.domain.record.dto.*
+import com.example.jhouse_server.domain.record.service.RecordService
+import com.example.jhouse_server.domain.user.entity.Authority.ADMIN
+import com.example.jhouse_server.domain.user.entity.User
+import com.example.jhouse_server.global.annotation.Auth
+import com.example.jhouse_server.global.annotation.AuthUser
+import com.example.jhouse_server.global.bucket.RateLimitService
+import com.example.jhouse_server.global.response.ApplicationResponse
+import org.springframework.data.domain.Pageable
+import org.springframework.data.web.PageableDefault
+import org.springframework.validation.annotation.Validated
+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.PutMapping
+import org.springframework.web.bind.annotation.RequestBody
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RequestParam
+import org.springframework.web.bind.annotation.RestController
+import javax.servlet.http.HttpServletRequest
+
+@RestController
+@RequestMapping("/api/v1/record")
+class RecordController(
+    private val recordService: RecordService,
+    private val rateLimitService: RateLimitService
+) {
+
+    @Auth(ADMIN)
+    @PostMapping
+    fun saveRecord(
+        @Validated @RequestBody recordReqDto: RecordReqDto,
+        @AuthUser user: User
+    ): ApplicationResponse<Long> {
+        return ApplicationResponse.ok(recordService.saveRecord(recordReqDto, user))
+    }
+
+    @Auth(ADMIN)
+    @PutMapping("/{record_id}")
+    fun updateRecord(
+        @Validated @RequestBody recordUpdateDto: RecordUpdateDto,
+        @AuthUser user: User,
+        @PathVariable("record_id") recordId: Long
+    ): ApplicationResponse<Long> {
+        return ApplicationResponse.ok(recordService.updateRecord(recordUpdateDto, user, recordId))
+    }
+
+    @Auth(ADMIN)
+    @DeleteMapping("/{record_id}")
+    fun deleteRecord(
+        @AuthUser user: User,
+        @PathVariable("record_id") recordId: Long
+    ): ApplicationResponse<Nothing> {
+        recordService.deleteRecord(user, recordId)
+        return ApplicationResponse.ok()
+    }
+
+    @GetMapping("/hot")
+    fun getHotRecords(): ApplicationResponse<RecordHotResDto> {
+        return ApplicationResponse.ok(recordService.getHotRecords())
+    }
+
+    @GetMapping("/{part}/{type}")
+    fun getRecords(
+        @PathVariable("part") part: String,
+        @PathVariable("type") type: String,
+        @RequestParam(value = "category", defaultValue = "") category: String,
+        @PageableDefault(size = 4) pageable: Pageable
+    ): ApplicationResponse<RecordPageResDto> {
+        return ApplicationResponse.ok(recordService.getRecords(RecordPageCondition(part, type, category), pageable))
+    }
+
+    @GetMapping("/{record_id}")
+    fun getRecord(
+        @PathVariable("record_id") recordId: Long,
+        request: HttpServletRequest,
+        @PageableDefault(size = 10) pageable: Pageable
+    ): ApplicationResponse<RecordResDto> {
+        return ApplicationResponse.ok(recordService.getRecord(recordId, rateLimitService.getClientIp(request), pageable))
+    }
+
+    @Auth(ADMIN)
+    @GetMapping("/review/{record_id}")
+    fun getRecordWithReview(
+        @PathVariable("record_id") recordId: Long
+    ): ApplicationResponse<RecordWithReviewResDto> {
+        return ApplicationResponse.ok(recordService.getRecordWithReview(recordId))
+    }
+
+    @Auth(ADMIN)
+    @GetMapping("/reviewee")
+    fun getRevieweeRecords(
+        @RequestParam("status", required = false) status: String?,
+        @AuthUser user: User,
+        @PageableDefault(size = 3) pageable: Pageable
+    ): ApplicationResponse<RecordPageResDto> {
+        return ApplicationResponse.ok(recordService.getRevieweeRecords(RecordReviewCondition(status), user, pageable))
+    }
+
+    @Auth(ADMIN)
+    @GetMapping("/reviewer")
+    fun getReviewerRecords(
+        @RequestParam("status", required = false) status: String?,
+        @AuthUser user: User,
+        @PageableDefault(size = 3) pageable: Pageable
+    ): ApplicationResponse<RecordPageResDto> {
+        return ApplicationResponse.ok(recordService.getReviewerRecords(RecordReviewCondition(status), user, pageable))
+    }
+}