Skip to Content
Last modified by Erik Bakker on 2024/09/03 08:20
From version 3.1
edited by Erik Bakker
on 2022/06/13 10:07
Change comment: There is no comment for this version
To version 1.1
edited by eMagiz
on 2022/05/05 10:08
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,0 @@
1 -Considerations for API Gateway or Messaging
Parent
... ... @@ -1,1 +1,0 @@
1 -WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.marijn
Content
... ... @@ -1,7 +1,16 @@
1 -{{container}}{{container layoutStyle="columns"}}(((
1 +{{html wiki="true"}}
2 +<div class="ez-academy">
3 + <div class="ez-academy_body">
4 +
5 +<div class="doc">
6 +
7 +
8 +
9 += Considerations for API Gateway or Messaging =
10 +
2 2  In this microlearning we'll take a moment to discuss several considerations for making the right choice between the two patterns
3 3  
4 -Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
13 +Should you have any questions, please get in touch with academy@emagiz.com.
5 5  
6 6  * Last update: December 2021
7 7  * Required reading time: 10 minutes
... ... @@ -16,33 +16,40 @@
16 16  
17 17  Please refer to the following Fundamentals to learn the key concepts of both patterns
18 18  
19 -* [[eMagiz API Gateway>>doc:Main.eMagiz Academy.Fundamentals.fundamental-api-gateway-introduction.WebHome||target="blank"]]
20 -* [[eMagiz Messaging>>doc:Main.eMagiz Academy.Fundamentals.fundamental-messaging-introduction.WebHome||target="blank"]]
28 +* [eMagiz API Gateway](../../docs/fundamental/fundamental-api-gateway-introduction)
29 +* [eMagiz Messaging](../../docs/fundamental/fundamental-event-streaming-introduction)
21 21  
31 +
32 +
22 22  == 3. Considerations for selecting Messaging or Event Streaming ==
23 23  
24 24  The following sections are helpful to understand what things to consider in selecting the right pattern.
25 25  
26 26  * **Synchronous**
27 - ** Both patterns in this discussion are synchronous in nature. In case a asynchronous message is the right choice, pelase refer to the relevant microlearning that compares Messaging and Event Streaming
38 + * Both patterns in this discussion are synchronous in nature. In case a asynchronous message is the right choice, pelase refer to the relevant microlearning that compares Messaging and Event Streaming
28 28  * **Data**
29 - ** Both patterns can handle similar type data - usually record based
40 + * Both patterns can handle similar type data - usually record based
30 30  * **Online vs. offline**
31 - ** For Messaging, the delivering and receiving system need to be online with high availability ratio's in order to process the messages. The same is true for a backend API provider which needs to be online to provide or consume data from API operations
32 32  
43 + * For Messaging, the delivering and receiving system need to be online with high availability ratio's in order to process the messages. The same is true for a backend API provider which needs to be online to provide or consume data from API operations
44 +
33 33  * **Error handling**
34 - ** In the case of an API Gateway, the requesting application needs to be handle the error messages that are returned by the API gateway in case there are any. The API Gateway provides the errors from the backend API directly back to the requestor who can then decide how to process the request.
35 - ** For Messagaging, the errors that are generated are pushed inside the general error process of eMagiz and displayed in the Error Dashboard in the Manage phase. However, the requestor also gets the error messages back from the Messaging system in order to handle these properly
46 + * In the case of an API Gateway, the requesting application needs to be handle the error messages that are returned by the API gateway in case there are any. The API Gateway provides the errors from the backend API directly back to the requestor who can then decide how to process the request.
47 + * For Messagaging, the errors that are generated are pushed inside the general error process of eMagiz and displayed in the Error Dashboard in the Manage phase. However, the requestor also gets the error messages back from the Messaging system in order to handle these properly
36 36  * **Contract & communication**
37 - ** Messaging required a fixed contract between the message definitions that are exchanged. A change of definition would result in validation issues and therefore more communication is required
38 - ** For an API Gateway solution, the contract is published via the API Gateway outwards. The basic idea is that the data definition is fixed and standardized, and that requesting application will adapt their request to this definition. In that sense the API Gateway offers standardization in the landscape
49 + * Messaging required a fixed contract between the message definitions that are exchanged. A change of definition would result in validation issues and therefore more communication is required
50 + * For an API Gateway solution, the contract is published via the API Gateway outwards. The basic idea is that the data definition is fixed and standardized, and that requesting application will adapt their request to this definition. In that sense the API Gateway offers standardization in the landscape
39 39  * **Technical disqualifiers**
40 - ** For an API Gateway, the requestor needs to be able to call a REST based webservice using JSON formatted messages.
41 - ** Messaging allows other web services such as SOAP, but can also handle XML for instance
52 +
53 + * For an API Gateway, the requestor needs to be able to call a REST based webservice using JSON formatted messages.
54 + * Messaging allows other web services such as SOAP, but can also handle XML for instance
55 +
42 42  * **Centralized User Management**
43 - ** API gateway offers a easy to configure user management capability to protect operations. Users and roles can be designed in the Design phase, and various authentication methods are allowed such as OAuth2.0 and API Keys. eMagiz offers easy to use configurations for that
44 - ** For Messaging, no such user management options exit and all needs to be created inside the flows that handle the requests & replies.
57 + * API gateway offers a easy to configure user management capability to protect operations. Users and roles can be designed in the Design phase, and various authentication methods are allowed such as OAuth2.0 and API Keys. eMagiz offers easy to use configurations for that
58 + * For Messaging, no such user management options exit and all needs to be created inside the flows that handle the requests & replies.
45 45  
60 +===== Practice =====
61 +
46 46  == 4. Assignment ==
47 47  
48 48  There is no assignment for now in this microlearning
... ... @@ -52,10 +52,19 @@
52 52  * There are a set of considerations to make decisions for API gateway vs. messaging
53 53  * Make sure to read the eMagiz Fundamentals properly before taking this section into account in your project
54 54  
71 +
72 +
55 55  == 6. Suggested Additional Readings ==
56 56  
57 -Take a moment to read the following [[Usecase>>doc:Main.eMagiz Academy.Use Cases.Pattern Determination.WebHome||target="blank"]]
75 +Take a moment to read the following link https://emagiz.github.io/docs/usecase/index_academy_usecase_pattern_discovery
58 58  
59 59  == 7. Silent demonstration video ==
60 60  
61 -As this is a more theoretical microlearning, we have no video that accompanies this microlearning.)))((({{toc/}}))){{/container}}{{/container}}
79 +As this is a more theoretical microlearning, we have no video that accompanies this microlearning.
80 +
81 +</div>
82 +</main>
83 +</div>
84 +</div>
85 +
86 +{{/html}}