기술 설계 · 양식
연동 명세서 양식
외부 시스템(파트너사·택배사·PG 등)과 주고받는 데이터의 방식·필드·인증·에러 처리를 계약 수준으로 명세한다.
이럴 때 써요
- 외부 시스템과 API·파일·메시지 큐로 데이터를 주고받아야 할 때
- 연동 파트너와 필드 매핑·에러 코드 기준이 달라 데이터가 어긋날 때
- 연동 장애 시 재시도·알림 기준을 미리 합의해야 할 때
양식 구성
8개 절로 이루어져 있습니다.
- 문서 정보
- 버전 · 대상 시스템 · 연동 방식 · 작성자 · 검토자 · 승인자 · 최종 수정일
- 1 연동 개요
- 누구와 무엇을 주고받는지 적는다. 상대 담당자와 문서 링크를 함께 두면 막혔을 때 빠르다.
- 2 인증 및 보안
- 인증 방식과 키 관리 방법을 적는다. 키를 어디에 두는지는 적되 값은 적지 않는다.
- 3 연동 항목 · 필드 매핑
- 우리 필드명과 상대 시스템 필드명이 다를 수 있어 매핑을 명시합니다.
- 4 요청 · 응답 예시
- 실제로 오가는 필드를 예시와 함께 적는다. 상대 문서를 그대로 옮기지 말고 우리가 쓰는 것만 추린다.
- 5 에러 처리 및 재시도
- 상대가 실패로 답했을 때 우리가 무엇을 할지 정한다. 재시도 정책이 없으면 중복 처리가 생긴다.
- 6 장애 시 연락 체계
- 연동이 멈췄을 때 누구에게 연락할지 적는다. 대응 시간(업무 시간인지 24시간인지)까지 확인해 적는다.
- 7 변경 이력
- 규격이 바뀌면 남긴다. 상대가 바꾼 것도 우리 쪽 이력에 남겨야 원인을 찾을 수 있다.
바로 써 보기
로그인 없이 바로 쓸 수 있습니다. 다 쓰면 PDF·Word·한글(HWPX)·Markdown 으로 내보냅니다.
기술 설계 단계의 다른 양식
- 상태 전이도 — 상태와 전이 규칙, 금지 전이와 알림 발송까지 표로 확정한다.
- 아키텍처 다이어그램 — 서버·DB·연동 구성 등 시스템 아키텍처를 외부 도구에서 그린 그대로 붙여 보관한다.
- 도메인 모델 정의서 — 엔티티·관계·상태를 개발자 기준으로 정의한다. 엔티티가 수십 개로 늘어도 모듈로 나눠 훑을 수 있게 한다.
- 데이터 정의서 — 화면·API 가 공통으로 참조하는 필드의 타입·정의·허용값을 한곳에 고정한다.
- 기술 설계서 (Tech Spec) — 아키텍처, 데이터 모델, API 설계를 개발 착수 전에 합의한다.
- API 명세서 — 엔드포인트별 요청·응답, 공통 에러 코드와 인증 규칙을 계약 수준으로 명세한다.
- 에러 코드 정의서 — 서비스 전체에서 쓰는 에러 코드 체계를 한곳에 고정해, API·배치·화면이 같은 코드를 같은 뜻으로 쓰게 한다.
- 배치 정의서 — 정기적으로 도는 배치·스케줄러 작업의 주기, 처리 로직, 실패 시 대응을 한곳에 정의한다.