엔드포인트 문서 작성 템플릿
새로운 API 문서 작성 시 사용하는 템플릿
템플릿
# 함수명 (한글 설명)
> 간단한 설명 한 줄
## 기본 정보
| 항목 | 값 |
|------|-----|
| URL | `https://asia-northeast3-construction24-test.cloudfunctions.net/함수명` |
| Method | POST |
| 인증 | Firebase ID Token 필요 / 불필요 |
| 권한 | 필요한 권한 설명 (선택) |
## 요청
### Body
| 필드 | 타입 | 필수 | 설명 | 검증 |
|------|------|:----:|------|------|
| token | string | O | Firebase ID Token | - |
| name | string | O | 이름 | - |
| phone | string | O | 휴대폰 | `010-XXXX-XXXX` |
| sex | string | O | 성별 | `male`, `female` |
### 요청 예시
\```json
{
"token": "eyJhbGci...",
"name": "홍길동",
"phone": "010-1234-5678",
"sex": "male"
}
\```
## 응답
### 성공 (200)
\```json
{
"message": "성공 메시지",
"doc_id": "생성된 ID"
}
\```
### 실패
| 코드 | message | 원인 |
|------|---------|------|
| 400 | "이미 등록된 이메일입니다" | 이메일 중복 |
| 403 | "인증이 필요합니다" | 토큰 없음/만료 |
| 500 | "서버 오류" | 내부 오류 |
## 참고
- 관련 API: [[다른_엔드포인트]]
- 추가 설명이 필요한 경우 여기에 작성
작성 가이드
- 함수명: 실제 API 엔드포인트 함수명 사용
- 설명: 한 줄로 간결하게 작성
- 요청 테이블: 필수 여부는 O/X로 표기
- 검증 규칙: ENUM 값 또는 형식 명시
- 응답: 성공/실패 케이스 모두 포함