3.3.3 메시징 기반 서비스의 API 명세 작성

서비스의 비동기 API 명세에는 메시지 채널명, 각 채널을 통해 교환되는 메시지 타입과 포맷을 명시하고, 메시지 포맷은 JSON, XML, 프로토콜 버퍼 등 표준 포맷으로 기술해야 합니다(그림 3-9). 그러나 REST, 오픈 API와 달리 채널 및 메시지 타입은 딱히 정해진 문서화 표준이 없으므로 자유롭게 기술하면 됩니다.

서비스 비동기 API는 클라이언트가 호출하는 작업과 서비스에 의해 발행되는 이벤트로 구성됩니다. 작업과 이벤트는 문서화하는 방법이 다릅니다.

▲ 그림 3-9 서비스의 비동기 API는 메시지 채널, 커맨드, 응답, 이벤트 메시지 타입으로 구성된다