api sample

This commit is contained in:
2025-11-17 09:39:18 +09:00
parent 74e1c6bb9c
commit 7d64ee897d
29 changed files with 918 additions and 126 deletions

View File

@@ -4,26 +4,22 @@
## 자동 포맷팅 구성
### 1. 커밋 시점 자동 체크 (Git Pre-commit Hook)
### 1. 커밋 시점 자동 포맷팅 (Git Pre-commit Hook)
커밋 전에 자동으로 코드 스타일을 체크하고, 문제가 있으면 커밋을 막습니다.
커밋 전에 자동으로 코드를 포맷팅하고 스테이징합니다.
**설정 완료:** `.git/hooks/pre-commit` 파일이 자동으로 실행됩니다.
**동작 방식:**
- 커밋 시도 시 `./gradlew spotlessCheck` 자동 실행
- 포맷팅 오류가 있으면 커밋 차단 및 안내 메시지 출력
- 포맷팅이 올바르면 커밋 허용
- 커밋 시도 시 `./gradlew spotlessApply` 자동 실행
- 스테이징된 Java 파일을 자동으로 포맷팅
- 포맷팅된 파일을 자동으로 다시 스테이징
- 포맷팅이 완료되면 커밋 진행
**포맷팅 오류 발생 시:**
```bash
# 자동 포맷팅 적용
./gradlew spotlessApply
# 변경사항 추가 후 다시 커밋
git add .
git commit
```
**장점:**
- 수동으로 `spotlessApply`를 실행할 필요 없음
- 항상 일관된 코드 스타일 유지
- 포맷팅 누락 방지
### 2. IntelliJ IDEA 저장 시점 자동 포맷팅
@@ -38,6 +34,7 @@ git commit
#### 방법 2: 저장 시 자동 포맷팅 활성화
**Option A: Actions on Save 설정**
1. **Settings/Preferences** > **Tools > Actions on Save**
@@ -84,7 +81,7 @@ git commit
프로젝트는 **Google Java Style Guide** 기반으로 다음 규칙을 따릅니다:
- **Indentation**: 2 spaces (탭 아님)
- **Line Length**: 100 characters
- **Line Length**: 180 characters
- **Line Endings**: LF (Unix-style)
- **Charset**: UTF-8
- **Import Order**: Static imports → 빈 줄 → Regular imports
@@ -112,4 +109,4 @@ chmod +x .git/hooks/pre-commit
- **Google Java Style Guide**: https://google.github.io/styleguide/javaguide.html
- **Spotless Plugin**: https://github.com/diffplug/spotless
- **IntelliJ Code Style**: https://www.jetbrains.com/help/idea/code-style.html
- **IntelliJ Code Style**: https://www.jetbrains.com/help/idea/code-style.html