Main 브랜치로 push

README.md

@@ -1 +1,36 @@
 # Kkeujeok_Backend
+## 커밋 메시지 컨벤션
+
+- Feat(#이슈 번호): 새로운 기능 추가
+- Fix(#이슈 번호): 버그 수정
+- Refactor(#이슈 번호): 코드 리팩토링 (기능 변경 없음)
+- Docs(#이슈 번호): 문서 수정
+- Style(#이슈 번호): 코드 포맷팅, 세미콜론 누락 등 (기능 변경 없음)
+- Test(#이슈 번호): 테스트 코드 추가 및 수정
+- Chore(#이슈 번호): 빌드 작업, 패키지 매니저 설정
+
+## 코드 스타일
+
+- 클래스 선언부 아래 필드가 오면 한 칸 띄우고 작성하고 그 이외의 경우에는 붙인다.
+- 메서드 길이는 10줄을 넘지 않는다.
+- 블록 들여쓰기는 1단계로 제한한다.
+- 블록 아래 한 칸 띄우고 작성한다.
+- else를 사용하지 않는다.
+- stream 사용 시 stream 뒤에 줄바꿈을 한다.
+- 필드에 어노테이션이 붙으면 한 칸 씩 띄어쓴다.
+
+## 메서드 명 컨벤션
+
+- 생성: save
+- 수정: update
+- 삭제: delete
+- 조회: find
+- 매개변수로 넘어오는 값을 메서드 명에 포함시킨다.
+
+## 코드 리뷰 컨벤션
+
+- 모든 PR은 최소 2명의 리뷰어가 승인한다.
+
+## 어노테이션 순서
+
+- 길이 내림차순

build.gradle

@@ -30,12 +30,15 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
     implementation 'org.springframework.boot:spring-boot-starter-web'
     compileOnly 'org.projectlombok:lombok'
-
+    implementation group: 'org.springframework.boot', name: 'spring-boot-starter-validation', version: '3.3.2'
+    implementation 'org.springframework.boot:spring-boot-starter-web-services'
+
     // logback
     implementation 'com.github.napstr:logback-discord-appender:1.0.0'
     implementation 'com.github.maricn:logback-slack-appender:1.4.0'
 
     runtimeOnly 'com.mysql:mysql-connector-j'
+    runtimeOnly 'com.h2database:h2'
 
     annotationProcessor 'org.projectlombok:lombok'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'

src/docs/asciidoc/block.adoc

@@ -1,12 +1,119 @@
-= 블록 API 문서
+== 블록 API 문서
 
-== 블록 생성 API
+=== 블록 생성 API
+
+==== 요청
 
-=== 요청
 include::{snippets}/block/save/http-request.adoc[]
 include::{snippets}/block/save/request-fields.adoc[]
 
-=== 응답
+==== 응답
 
 include::{snippets}/block/save/http-response.adoc[]
 include::{snippets}/block/save/response-fields.adoc[]
+
+=== 블록 수정 API
+
+==== 요청
+
+include::{snippets}/block/update/http-request.adoc[]
+include::{snippets}/block/update/path-parameters.adoc[]
+include::{snippets}/block/update/request-fields.adoc[]
+
+==== 응답
+
+include::{snippets}/block/update/http-response.adoc[]
+include::{snippets}/block/update/response-fields.adoc[]
+
+=== 블록 상태 수정 API
+
+==== 요청
+
+include::{snippets}/block/progress/update/http-request.adoc[]
+include::{snippets}/block/progress/update/path-parameters.adoc[]
+include::{snippets}/block/progress/update/query-parameters.adoc[]
+
+==== 응답
+
+include::{snippets}/block/progress/update/http-response.adoc[]
+include::{snippets}/block/progress/update/response-fields.adoc[]
+
+=== 블록 상태 수정 실패 API (400 Bad Request)
+
+==== 요청
+
+include::{snippets}/block/progress/update/failure/http-request.adoc[]
+include::{snippets}/block/progress/update/failure/path-parameters.adoc[]
+include::{snippets}/block/progress/update/failure/query-parameters.adoc[]
+
+==== 응답
+
+include::{snippets}/block/progress/update/failure/http-response.adoc[]
+
+=== 블록 상태별 전체 조회
+
+==== 요청
+
+include::{snippets}/block/findByBlockWithProgress/http-request.adoc[]
+include::{snippets}/block/findByBlockWithProgress/query-parameters.adoc[]
+
+==== 응답
+
+include::{snippets}/block/findByBlockWithProgress/http-response.adoc[]
+include::{snippets}/block/findByBlockWithProgress/response-fields.adoc[]
+
+=== 블록 상세 조회
+
+==== 요청
+
+include::{snippets}/block/findById/http-request.adoc[]
+include::{snippets}/block/findById/path-parameters.adoc[]
+
+==== 응답
+
+include::{snippets}/block/findById/http-response.adoc[]
+include::{snippets}/block/findById/response-fields.adoc[]
+
+=== 블록 삭제
+
+==== 요청
+
+include::{snippets}/block/delete/http-request.adoc[]
+include::{snippets}/block/delete/path-parameters.adoc[]
+
+==== 응답
+
+include::{snippets}/block/delete/http-response.adoc[]
+
+=== 블록 상태 변경
+
+==== 요청
+
+include::{snippets}/block/change/http-request.adoc[]
+
+==== 응답
+
+include::{snippets}/block/change/http-response.adoc[]
+
+=== 삭제된 블록 조회
+
+==== 요청
+
+include::{snippets}/block/findDeletedBlocks/http-request.adoc[]
+include::{snippets}/block/findDeletedBlocks/query-parameters.adoc[]
+
+==== 응답
+
+include::{snippets}/block/findDeletedBlocks/http-response.adoc[]
+include::{snippets}/block/findDeletedBlocks/response-fields.adoc[]
+
+=== 블록 영구 삭제
+
+==== 요청
+
+include::{snippets}/block/deletePermanentBlock/http-request.adoc[]
+include::{snippets}/block/deletePermanentBlock/path-parameters.adoc[]
+
+==== 응답
+
+include::{snippets}/block/deletePermanentBlock/http-response.adoc[]