docs: API 문서 업데이트

- 멤버 API: 영문명 조회 지원 추가
- 일정 API: 특수 일정 ID 형식 설명 추가

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
caadiq 2026-01-25 20:39:39 +09:00
parent f86e7d1b33
commit dc216a0f98

View file

@ -19,9 +19,16 @@ Base URL: `/api`
### GET /members ### GET /members
멤버 목록 조회 멤버 목록 조회
### GET /members/:id ### GET /members/:name
멤버 상세 조회 멤버 상세 조회
**Parameters:**
- `name` - 멤버 이름 (한글 또는 영문, 대소문자 무관)
**예시:**
- `/members/박지원` - 한글명으로 조회
- `/members/jiwon` - 영문명으로 조회
--- ---
## 앨범 ## 앨범
@ -66,6 +73,11 @@ Base URL: `/api`
] ]
} }
``` ```
**특수 일정 ID 형식:**
- 생일: `birthday-{year}-{nameEn}` (예: `birthday-2026-jiwon`)
- 데뷔: `debut-{year}` (예: `debut-2018`)
- 주년: `anniversary-{year}` (예: `anniversary-2026`)
`time`: 시간이 없는 일정은 `null`, 00:00 시간은 `"00:00:00"`으로 반환 `time`: 시간이 없는 일정은 `null`, 00:00 시간은 `"00:00:00"`으로 반환
``` ```