API Specification

API 명세서 — {{서비스명}}

항목	내용
서비스	{{서비스 목록}}
인증	{{인증 방식, 인증 불필요 엔드포인트}}
Base URL (로컬)	{{http://localhost:8080}}
데이터 형식	JSON (Content-Type: application/json)

---

공통 규칙

• 모든 실패 응답은 아래 형태를 따른다.

{
  "error": "사용자에게 보여줄 메시지",
  "code": "ERROR_CODE"
}

• {{날짜/시간 형식 등 공통 규칙}}

---

1. Health Check

GET /health/live

{{설명}}

응답 (200 OK)

GET /health/ready

{{설명}}

응답 (200 OK) / 응답 (503 Service Unavailable)

---

2. {{리소스}} API

2.1 {{METHOD}} {{/api/...}} — {{설명}} ({{인증 필요 여부}})

{{설명}}

요청

파라미터	위치	타입	필수	설명
{{name}}	{{path/query/body}}	{{type}}	{{Y/N}}	{{설명}}

응답 (200 OK)

{}

응답 (4xx) — {{상황}}

{}

---

{{N}}. 상태 코드 전체 요약

상태 코드	code	상황
{{400}}	{{CODE}}	{{상황}}

{{N+1}}. 후속 논의 항목

• {{미정 사항}}