# API 문서 작성 양식

스펙브릿지 팀 · https://specbridge.kr/blog/api-specification-template/

## 기본 정보
- API 이름:
- 목적과 사용 범위:
- 담당자 / 최종 확인일:
- 개발·운영 기본 주소:
- HTTP 메서드 / 경로:
- 인증 방식 / 필요한 권한:

## 요청
| 위치 | 이름 | 타입 | 필수 | 허용 값·제약 | 예시 |
| --- | --- | --- | --- | --- | --- |
| 헤더·경로·쿼리·본문 | | | | | |

요청 본문 형식:
요청 본문 예시:

## 성공 응답
상태 코드:

| 필드 | 타입 | 항상 포함 | null 허용 | 단위·설명 | 예시 |
| --- | --- | --- | --- | --- | --- |
| | | | | | |

성공 응답 예시:

## 오류 응답
| HTTP 상태 | 오류 코드 | 발생 조건 | 호출자의 처리 방법 |
| --- | --- | --- | --- |
| | | | |

오류 응답 예시:

## 운영 기준
- 호출 제한 / 재시도:
- 중복 요청 처리:
- 변경 내용 / 적용 예정일:
- 검토자 / 외부에 제공할 버전:
- 전달 대상 / 최신 문서 위치:

## 전달 전 확인
- 실제 서버와 메서드·경로·필드·오류가 일치하는가?
- 예시에 실제 토큰·고객 정보·내부 전용 주소가 없는가?
- 상대방에게 필요한 문서만 전달하는가?
- 수정 중인 초안과 외부 배포본을 구분했는가?