-
-
Notifications
You must be signed in to change notification settings - Fork 717
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: new concept doc application (#992)
Co-authored-by: Lukasz Gornicki <[email protected]> Co-authored-by: akshatnema <[email protected]>
- Loading branch information
1 parent
02a1a6d
commit 195b486
Showing
4 changed files
with
48 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
title: Application | ||
weight: 23 | ||
--- | ||
|
||
|
||
## What is an application? | ||
An application is any computer program or a group of them. | ||
|
||
An application could also be a micro-service, IoT device (sensor), mainframe process, etc. Users may even write applications in different programming languages if they support one of the selected protocols. | ||
|
||
## Why do we need applications? | ||
In Event-Driven Architecture (EDA), an application must be a `producer`, a `consumer`, or both. Applications must also use the protocols the server supports if they wish to connect and exchange messages. | ||
|
||
### Applications: producers and consumers | ||
```mermaid | ||
flowchart TD | ||
A[PRODUCER application] --> B[message] | ||
B --> C[channel] | ||
C --> D[message] | ||
D --> F[CONSUMER application] | ||
``` | ||
The above diagram describes a message communication traveling through a channel between a **PRODUCER application** and a **CONSUMER application**. | ||
|
||
<Remember> | ||
When writing your AsyncAPI document, make sure to describe what a user can do with your application; not what the application does. In other words, if your <em>application</em> is a <b>producer</b>, your AsyncAPI document should describe where users can subscribe to, to receive messages produced by your <b>producer</b> application. | ||
</Remember> | ||
|
||
<DocsButton | ||
suggestions={[ | ||
{ | ||
href: '/docs/concepts/channel', | ||
title: 'Channel', | ||
type:'back', | ||
}, | ||
{ | ||
href: '/docs/concepts/protocol', | ||
title: 'Protocol', | ||
type:'next', | ||
} | ||
]} | ||
/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters