공공기관 내부 연계 인터페이스 설계서 정리 (개발자 관점)
1. 인터페이스 설계서란 무엇인가
인터페이스 설계서는 시스템 간 데이터 연계를 수행하기 위해 송신 시스템과 수신 시스템 사이의 데이터 흐름, 규칙, 구조를 명확히 정의한 기술 문서입니다.
특히 공공기관에서는 단순한 개발 참고 문서가 아니라, 운영, 보안, 감사, 장애 대응을 위한 핵심 기준 문서로 활용됩니다.
인터페이스 설계서에 반드시 포함되어야 하는 항목
- 송신 시스템 / 수신 시스템 정보
- 연계 방식 (ESB, REST, FILE 등)
- 연계 주기 (실시간, 배치, 주기적)
- 데이터 매핑 규칙 (컬럼 단위)
- 트랜잭션 관리 방식
- 오류 처리 및 재처리 기준
- 인터페이스 전용 테이블 구조
2. 공공기관 인터페이스 설계의 핵심 원칙
① 보안과 추적성이 최우선
공공기관에서는 개인정보, 행정정보를 다루기 때문에 누가, 언제, 어떤 데이터를, 어떤 시스템으로 전송했는지를 항상 추적할 수 있어야 합니다.
② 운영 테이블 직접 접근은 지양
운영 DB 테이블을 외부 시스템이 직접 조회하거나 수정하는 방식은 보안, 성능, 장애 확산 측면에서 매우 위험합니다.
따라서 반드시 인터페이스 전용 테이블(I/F Table)을 사용해야 합니다.
③ 인터페이스 전용 테이블 사용
- 송신용 인터페이스 테이블 (Send Staging)
- 수신용 인터페이스 테이블 (Recv Staging)
④ 테이블 명명 규칙 (접두어 사용)
공공기관 표준에서는 인터페이스 테이블을 쉽게 식별하기 위해 접두어 사용을 권장합니다.
3. 표준 인터페이스 아키텍처 흐름
이 구조는 시스템 간 직접 결합을 방지하고, 장애 발생 시 영향을 최소화하기 위한 공공기관 표준 구조입니다.
4. ESB와 JMS Transport의 역할
ESB (Enterprise Service Bus)
- 시스템 간 메시지 중계
- 프로토콜 변환
- 재전송 및 장애 처리
- 연계 흐름 중앙 통제
JMS Transport
JMS는 메시지를 큐 기반으로 전달하여 송신/수신 시스템의 처리 속도 차이를 흡수합니다.
5. 트랜잭션(Transaction)의 정확한 의미
트랜잭션이란
트랜잭션이란 더 이상 나눌 수 없는 하나의 업무 처리 단위입니다.
은행 출금 예시
- A 사용자가 10만원 출금 요청
- 동시에 다른 출금 요청 발생 가능
- 중복 처리 방지를 위해 고유 트랜잭션 ID 필수
인터페이스 연계에서도 동일하게 각 연계 건마다 고유 트랜잭션 ID를 부여해야 합니다.
6. 필수 관리 컬럼 정의 (매우 중요)
| 컬럼명 | 설명 |
|---|---|
| IF_ID | 인터페이스 식별자 |
| TX_ID | 트랜잭션 고유번호 |
| PROC_ST | 처리 상태 (N:미처리, S:성공, E:오류) |
| REG_DT | 등록 일시 |
| SEND_DT | 송신 일시 |
| ERR_CD | 오류 코드 |
| ERR_MSG | 오류 메시지 |
7. DDL 설계 시 핵심 포인트
① 인터페이스 전용 테이블 생성
- 운영 테이블과 분리
- 컬럼 변경 시 연계 영향 최소화
② 인덱스 전략 (가장 중요)
연계 성능 이슈의 약 90%는 DB 조회 성능 문제에서 발생합니다.
송신 어댑터 조회 패턴
필수 복합 인덱스 예시
트랜잭션 ID는 일반적으로 인터페이스 ID + 등록일시 조합으로 생성되며, 이 역시 인덱스 설계에 반드시 반영되어야 합니다.
8. 인터페이스 설계서가 없는 경우 발생하는 문제
- 연계 오류 발생 시 원인 추적 불가
- 담당자 변경 시 인수인계 실패
- 중복 전송, 누락 데이터 발생
- 장애 복구 시간 급증
- 감사 및 점검 시 치명적 지적 사항
9. 정리
인터페이스 설계서는 단순한 개발 문서가 아니라, 공공기관 시스템 연계의 생명줄입니다.
특히 인터페이스 테이블 설계, 트랜잭션 관리, 인덱스 전략은 실무에서 가장 중요한 판단 요소입니다.
'이론' 카테고리의 다른 글
| 인공지능의 진화 단계: ANI, AGI 그리고 ASI의 이해 (0) | 2026.03.25 |
|---|---|
| ESB란? (0) | 2025.12.17 |
| API gateway (0) | 2025.12.15 |