A Complete Guide to AsyncAPI Specifications

A portion of this content is derived from the excellent work of the OpenAPI Initiative team

[{"selector":"#anim-ef26d843-1b85-4cb5-bade-ed196a94b710 [data-leaf-element=\"true\"]","keyframes":{"transform":["translate3d(-39.20062148143111%, 0, 0) translate(-25%, 0%) scale(1.5)","translate3d(0%, 0, 0) translate(0%, 0%) scale(1)"]},"delay":0,"duration":2000,"fill":"forwards"}] [{"selector":"#anim-555a225a-7e04-4873-b804-592aa0273ae4","keyframes":{"transform":["translate3d(-117.02128%, 0px, 0)","translate3d(0px, 0px, 0)"]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"both"}] [{"selector":"#anim-a6989872-34af-4d60-8d90-84f0b527fb9f","keyframes":{"opacity":[0,1]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"both"}] [{"selector":"#anim-c2cf7589-ebdc-4a61-bec3-c960d7d2bfdd","keyframes":{"transform":["scale(0.15)","scale(1)"]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"forwards"}]

A project called AsyncAPI Specification aims to provide machine-readable descriptions of message-driven APIs

[{"selector":"#anim-e472b1e5-b665-438b-98c8-2db67a0d5b71 [data-leaf-element=\"true\"]","keyframes":{"transform":["translate3d(-34.249999904429615%, 0, 0) translate(-25%, 0%) scale(1.5)","translate3d(0%, 0, 0) translate(0%, 0%) scale(1)"]},"delay":0,"duration":2000,"fill":"forwards"}] [{"selector":"#anim-fee86df9-5e49-4837-b752-5ed8f9ea6fa3","keyframes":{"transform":["translate3d(123.80952%, 0px, 0)","translate3d(0px, 0px, 0)"]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"both"}] [{"selector":"#anim-eb23ea81-d4ce-419f-a409-e3e95e54bfff","keyframes":{"opacity":[0,1]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"both"}] [{"selector":"#anim-975fca95-bec6-4ccc-83bb-00d315577d9b","keyframes":{"transform":["scale(0.15)","scale(1)"]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"forwards"}]

A set of attributes that can be used in an AsyncAPI document to describe an application’s API is defined by the AsyncAPI Specification

[{"selector":"#anim-43cc6c98-97c3-410b-8776-26d0a5d83fef [data-leaf-element=\"true\"]","keyframes":{"transform":["translate3d(-34.249999904429615%, 0, 0) translate(-25%, 0%) scale(1.5)","translate3d(0%, 0, 0) translate(0%, 0%) scale(1)"]},"delay":0,"duration":2000,"fill":"forwards"}] [{"selector":"#anim-2a414248-71b5-402b-ba79-70795f2713a4","keyframes":{"transform":["translate3d(-115.18988%, 0px, 0)","translate3d(0px, 0px, 0)"]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"both"}] [{"selector":"#anim-de270363-d014-44f4-99a3-8588a2577648","keyframes":{"opacity":[0,1]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"both"}] [{"selector":"#anim-47906d9d-170c-47aa-9b2d-6fddb78cebdb","keyframes":{"transform":["scale(0.15)","scale(1)"]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"forwards"}]

The actions that an application takes SHOULD be detailed in the AsyncAPI specification

[{"selector":"#anim-57158c72-aeba-4f62-a25a-1874264990fc [data-leaf-element=\"true\"]","keyframes":{"transform":["translate3d(-34.249999904429615%, 0, 0) translate(-25%, 0%) scale(1.5)","translate3d(0%, 0, 0) translate(0%, 0%) scale(1)"]},"delay":0,"duration":2000,"fill":"forwards"}] [{"selector":"#anim-a204c701-4a23-43c3-84bd-30bceb7944c8","keyframes":{"transform":["translate3d(115.18987%, 0px, 0)","translate3d(0px, 0px, 0)"]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"both"}] [{"selector":"#anim-16292c40-e599-4b86-b433-bf34250aa99a","keyframes":{"opacity":[0,1]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"both"}] [{"selector":"#anim-56554604-ea8a-40b1-91a1-dc4f2a2cc1bb","keyframes":{"transform":["scale(0.15)","scale(1)"]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"forwards"}]

Software topology, architecture, or pattern of any type is not assumed by the AsyncAPI definition

[{"selector":"#anim-f925d830-03c9-43e5-943d-a3ec69fa919f [data-leaf-element=\"true\"]","keyframes":{"transform":["translate3d(-28.93339755556636%, 0, 0) translate(-25%, 0%) scale(1.5)","translate3d(0%, 0, 0) translate(0%, 0%) scale(1)"]},"delay":0,"duration":2000,"fill":"forwards"}] [{"selector":"#anim-6dff89d1-6c6b-4b32-9883-0bf4d9996bd0","keyframes":{"transform":["translate3d(115.18987%, 0px, 0)","translate3d(0px, 0px, 0)"]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"both"}] [{"selector":"#anim-3acb550c-4a2b-4bf3-9ae7-9a6b45351d46","keyframes":{"opacity":[0,1]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"both"}] [{"selector":"#anim-cd12be4b-6beb-47d0-9309-4b889e972458","keyframes":{"transform":["scale(0.15)","scale(1)"]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"forwards"}]

It is not guaranteed that an application sending messages will utilise the same channel that another application is using to receive them

[{"selector":"#anim-37511550-e239-4d8d-b375-f74e474c71d9 [data-leaf-element=\"true\"]","keyframes":{"transform":["translate3d(-34.103260773104424%, 0, 0) translate(-25%, 0%) scale(1.5)","translate3d(0%, 0, 0) translate(0%, 0%) scale(1)"]},"delay":0,"duration":2000,"fill":"forwards"}] [{"selector":"#anim-1f077cd1-1066-4a33-a826-2b7f0ee9a8dc","keyframes":{"transform":["translate3d(121.73912%, 0px, 0)","translate3d(0px, 0px, 0)"]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"both"}] [{"selector":"#anim-ebab2a9b-d1c2-4823-9b5f-4fc55713907d","keyframes":{"opacity":[0,1]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"both"}] [{"selector":"#anim-e23c79a4-1582-41c2-8cc2-bec8b5094ac8","keyframes":{"transform":["scale(0.15)","scale(1)"]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"forwards"}]

A message broker that can send and/or receive messages between a sender and a recipient MAY be a server

[{"selector":"#anim-2c67651b-fa07-415b-98ab-b2c712e69e40 [data-leaf-element=\"true\"]","keyframes":{"transform":["translate3d(-34.249999904429615%, 0, 0) translate(-25%, 0%) scale(1.5)","translate3d(0%, 0, 0) translate(0%, 0%) scale(1)"]},"delay":0,"duration":2000,"fill":"forwards"}] [{"selector":"#anim-1f6649ed-f21b-41f4-ae8e-f1918c9fe02b","keyframes":{"transform":["translate3d(-115.18988%, 0px, 0)","translate3d(0px, 0px, 0)"]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"both"}] [{"selector":"#anim-b9faedcb-d005-4bc8-bb25-7df36e2cc849","keyframes":{"opacity":[0,1]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"both"}] [{"selector":"#anim-c34b0247-d718-4040-b073-ba202f9d0594","keyframes":{"transform":["scale(0.15)","scale(1)"]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"forwards"}]

An AsyncAPI document MAY consist of a single document or, at the author’s option, be composed of several related portions For more details govindhtech.com

[{"selector":"#anim-a934da9a-802d-4dfa-8789-7ed655740721 [data-leaf-element=\"true\"]","keyframes":{"transform":["translate3d(-34.249999904429615%, 0, 0)","translate3d(0%, 0, 0)"]},"delay":0,"duration":2000,"easing":"cubic-bezier(.3,0,.55,1)","fill":"both"}] [{"selector":"#anim-ee802c14-dd84-46da-85f6-822c19971702","keyframes":{"transform":["translate3d(123.80952%, 0px, 0)","translate3d(0px, 0px, 0)"]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"both"}] [{"selector":"#anim-a72215a0-0320-4e1f-9e2b-efab3b8ed9a1","keyframes":{"opacity":[0,1]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"both"}] [{"selector":"#anim-afec9cf2-d521-4e9c-aca2-88330b90773a","keyframes":{"transform":["scale(0.15)","scale(1)"]},"delay":0,"duration":600,"easing":"cubic-bezier(0.4, 0.4, 0.0, 1)","fill":"forwards"}]