인터페이스 명세서
IT 위키
더 많은 작업
- Interface Specification
- 시스템 간 연계에 필요한 송수신 시스템, 연계 방식, 송수신 데이터, 오류 처리 방안 등을 상세히 정의한 설계 산출물
- 내부·외부 모듈 또는 시스템 간 데이터를 주고받기 위한 약속을 문서로 명확히 한 것이다.
- 인터페이스 요구사항 명세 → 대상 식별 → 상세 설계(데이터 명세화, 오류 처리 방안 명세화) → 산출물 검증 순으로 작성·확정한다.
| 항목 | 내용 |
|---|---|
| 인터페이스 ID·명칭 | 인터페이스를 식별하는 번호와 이름 |
| 송신 시스템 | 데이터를 보내는 시스템, 담당자, 송신 프로그램·테이블 |
| 수신 시스템 | 데이터를 받는 시스템, 담당자, 수신 프로그램·테이블 |
| 연계 방식 | DB 링크, API, 파일, 소켓, EAI, ESB, 웹 서비스 등 |
| 처리 유형·주기 | 실시간, 배치(일·주·월 단위 등), 지연 처리 |
| 데이터 명세 | 송수신 항목, 데이터 형식, 길이, 필수 여부, 코드 매핑 |
| 오류 처리 방안 | 오류 유형, 오류 코드, 처리 방법, 재처리 절차 |
- 인터페이스 정의서는 시스템 간 인터페이스 목록과 개요를, 인터페이스 명세서는 개별 인터페이스의 상세 내용을 기술하는 방식으로 구분하여 쓰기도 한다.
- 오류 유형 식별: 연계 서버·네트워크 장애, 송신 시스템 데이터 추출 오류, 데이터 변환 오류, 수신 시스템 반영 오류 등
- 오류 코드와 오류 메시지를 정의하고 유형별 처리 방법을 명세한다.
- 대표적 처리 방법
- 사용자 화면에 오류 메시지를 표시한다.
- 오류 로그를 생성하여 기록한다.
- 연계 테이블 등에 오류 사항과 처리 상태를 기록하여 재처리에 활용한다.
- 작성한 인터페이스 명세서가 요구사항을 모두 반영하는지 추적표 등으로 확인한다.
- 송수신 시스템 담당자와 함께 데이터 항목, 형식, 주기, 오류 처리 방안의 일치 여부를 검토한다.
- 인터페이스 구현 후 명세서에 정의된 대로 데이터가 송수신되고 오류가 처리되는지 확인한다.
- 인터페이스 구현 검증 도구와 감시 도구를 활용하며, 자세한 내용은 인터페이스 보안 문서의 연계 테스트 부분을 참고한다.
- 인터페이스 명세서에 포함되는 항목(송수신 시스템, 연계 방식, 데이터 명세, 오류 처리 방안)을 묻는다.
- 데이터 표현 형식(JSON, XML)과 연계 방식(DB 링크, API, EAI, ESB, 소켓, 웹 서비스)을 구분하는 문제가 출제된다.
- 인터페이스 오류 처리 방법(화면 메시지 출력, 오류 로그 생성, 테이블에 오류 기록)이 실기 서술·단답형으로 출제된다.