3장. 인터페이스 방법 명세화

1. 인터페이스 방법 명세화의 개념

인터페이스 방법 명세화는 내외부 시스템이 연계하여 작동할 때 인터페이스별 송수신 방법, 송수신 데이터, 오류 식별 및 처리 방안에 대한 내용을 문서로 명확하게 정리하는 것이다.

• 인터페이스별로 송수신 방법을 명세화하기 위해서는 시스템 연계 기술, 인터페이스 통신 유형, 처리 유형, 발생 주기 등에 대한 정보가 필요하다.

---

2. 시스템 연계 기술

시스템 연계 기술은 개발할 시스템과 내외부 시스템을 연계할 때 사용되는 기술을 의미한다.

• 주요 시스템 연계 기술에는 DB Link, API/OPEN API, 연계 솔루션, Socket, Web Service 등이 있다.
  • DB Link : DB에서 제공하는 DB Link 객체를 이용하는 방식이다.
  • API/Open API : 송신 시스템의 데이터베이스(DB)에서 데이터를 읽어 와 제공하는 애플리케이션 프로그래밍 인터페이스 프로그램이다.
  • 연계 솔루션 : EAI 서버와 송수신 시스템에 설치되는 클라이언트(Client)를 이용하는 방식이다.
  • Socket : 서버는 통신을 위한 소켓(Socket)을 생성하여 포트를 할당하고 클라이언트의 통신 요청 시 클라이언트와 연결하여 통신하는 네트워크 기술이다.
  • Web Service : 웹 서비스(Web Service)에서 WSDL과 UDDI, SOAP 프로토콜을 이용하여 연계하는 서비스이다.

---

3. 인터페이스 통신 유형

인터페이스 통신 유형은 개발할 시스템과 내외부 시스템 간 데이터를 송수신하는 형태를 의미한다.

• 인터페이스 통신 유형에는 단방향, 동기, 비동기 방식 등이 있다.
  • 단방향 : 시스템에서 거래를 요청만 하고 응답이 없는 방식이다.
  • 동기 : 시스템에서 거래를 요청하고 응답이 올 때까지 대기(Request-Reply) 하는 방식이다.
  • 비동기 : 시스템에서 거래를 요청하고 다른 작업을 수행하다 응답이 오면 처리하는 방식(Send-Receive, Send-Recieve0Acknowlege, Publish-Subscribe)이다.

---

4. 인터페이스 처리 유형

인터페이스 처리 유형은 송수신데이터를 어떤 형태로 처리할 것인지에 대한 방식을 의미한다.

• 업무의 성격과 송수신 데이터 전송량을 고려하여 실시간, 지연 처리, 배치 방식 등으로 구분한다.
  • 실시간 방식 : 사용자가 요청한 내용을 바로 처리해야 할 때 사용하는 방식이다.
  • 지연 처리 방식 : 데이터를 매건 단위로 처리할 경우 비용이 많이 발생할 때 사용하는 방식이다.
  • 배치 방식 : 대량의 데이터를 처리할 때 사용하는 방식이다.

---

5. 인터페이스 발생 주기

인터페이스 발생 주기는 개발할 시스템과 내외부 시스템 간 송수신 데이터가 전송되어 인터페이스가 사용되는 주기를 의미한다.

• 인터페이스 발생 주기는 업무의 성격과 송수신 데이터 전송량을 고려하여 매일, 수시, 주 1회 등으로 구분한다.

---

6. 송수신 방법 명세화

송수신 방법 명세화는 내외부 인터페이스 목록에 있는 각각의 인터페이스에 대해 연계 방식, 통신 및 처리 유형, 발생 주기 등의 송수신 방법을 정의하고 명세를 작성하는 것이다.

• 연계 방식, 통신 유형, 연계 처리 형태는 시스템 인터페이스 설계 시 작성한 아키텍처 정의서를 기반으로 하여 업무 및 데이터의 성격, 연계 데이터 발생 건수, 연계 시스템의 기술 구조, 시스템 간의 성능 등을 고려하여 작성한다.

---

7. 송수신 데이터 명세화

송수신 데이터 명세화는 내외부 인터페이스 목록에 있는 각각의 인터페이스에 대해 인터페이스 시 필요한 송수신 데이터에 대한 명세를 작성하는 것이다.

• 인터페이스별로 테이블 정의서와 파일 레이아웃에서 연계하고자 하는 테이블 또는 파일 단위로 송수신 데이터에 대한 명세를 작성한다.

---

8. 오류 식별 및 처리 방안 명세화

오류 식별 및 처리 방안 명세화는 내외부 인터페이스 목록에 있는 각각의 인터페이스에 대해 인터페이스 시 발생할 수 있는 오류를 식별하고 오류 처리 방안에 대한 명세를 작성하는 것이다.

• 시스템 및 전송 오류, 연계 프로그램 등에서 정의한 예외 상황 등 대내외 시스템 연계 시 발생할 수 있는 다양한 오류 상황을 식별하고 분류한다.
• 오류 상황에 대해 오류 코드, 오류 메시지, 오류 설명, 해결 방법 등을 명세화 한다.