위키득계정 ↗
기술

AsyncAPI

AsyncAPI기술
주요 대상
메시지 기반 응용 인터페이스
통신 위치
서버와 채널
교환 내용
메시지 정의
동작 표현
보내기와 받기
AsyncAPI는 메시지를 주고받는 응용의 인터페이스를 문서로 표현하는 규격이다. 연결할 서버와 채널 및 메시지, 응용이 수행하는 송수신 동작을 구분해 기술한다.

서버와 채널의 구분

서버 정의는 연결할 네트워크 지점이나 메시지 브로커의 정보를 담는다. 채널 정의는 응용이 사용하는 주소와 목적 및 예상 메시지를 설명한다.

응용의 송수신 동작

동작은 응용이 어떤 채널로 메시지를 보내거나 받는지 나타낸다. 같은 채널의 설명과 특정 응용이 그 채널에서 수행하는 행동을 분리해 인터페이스를 기술할 수 있다.

재사용하는 구성 요소

공통 메시지와 스키마 및 서버 같은 정의를 구성 요소에 두고 참조할 수 있다. 여러 위치에서 같은 구조를 다시 적는 부담을 줄이면서 메시지 기반 통신의 계약을 표현한다.

관련 문서

OpenAPI 명세 / JSON Schema / JSON-RPC / Apache Avro / 프로토콜 버퍼 / API