API 명세서
| 상호 | |||
|---|---|---|---|
| 서비스 | |||
| API 이름 | 버전 | ||
| Method | |||
| URL | |||
| 인증 | 작성일 | ||
설명
요청 파라미터
| 이름 | 위치 | 타입 | 필수 | 설명 | 예시 |
|---|---|---|---|---|---|
응답 필드
| 이름 | 타입 | 설명 | 예시 |
|---|---|---|---|
응답 예시
오류 코드
| HTTP 상태 | 코드 | 의미·대처 |
|---|---|---|
API 명세서 양식 작성 안내
API 명세서는 API의 Method·URL·인증 방식과 요청 파라미터, 응답 필드, 응답 예시, 오류 코드를 한 장에 정리하는 개발 문서입니다.
API 명세서, 우리 회사에 딱 맞게 바꾸고 싶다면? “휴게시간 칸 추가”, “결재란 빼기”처럼 한 줄로 적으면 AI가 이 양식을 바탕으로 고쳐 드려요.
작성 방법
- 서비스·API 이름·버전·Method·URL·인증을 적습니다.
- 요청 파라미터의 위치·타입·필수 여부와 응답 필드를 표로 정리합니다.
- 응답 예시(JSON)와 오류 코드별 의미를 적습니다.
작성 팁 · 주의사항
- 예시 값을 실제처럼 적으면 연동하는 쪽이 훨씬 빨리 이해합니다.
- 날짜·금액의 형식과 단위를 꼭 적으세요.
자주 묻는 질문
API 명세서 파일 받기: 위쪽 ‘내보내기’ → 한글(HWPX)·워드(DOCX)·PDF
함께 쓰는 양식
IT·개발 양식 더 보기: 테스트 케이스 · 배포 보고서 · 서비스 장애 보고서 · 버그 리포트 · 릴리스 노트 · 코드 리뷰 체크리스트 · 스프린트 회고록 · 인수 테스트 확인서
↑ API 명세서 작성하러 가기