Skip to Content
Last modified by Danniar Firdausy on 2024/09/30 17:12
From version 26.1
edited by Eva Torken
on 2023/08/25 11:31
Change comment: There is no comment for this version
To version 21.1
edited by Erik Bakker
on 2022/06/10 08:38
Change comment: Imported from XAR

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,0 @@
1 -Updating your API Gateway Operations
Parent
... ... @@ -1,1 +1,0 @@
1 -WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.etorken
1 +XWiki.ebakker
Default language
... ... @@ -1,1 +1,0 @@
1 -en
Content
... ... @@ -1,9 +1,13 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 += Updating your API Gateway Operations =
2 2  
3 3  In our crash course on the API Gateway pattern, we have learned about setting up the API Gateway. However, we did not yet delve into the specifics of how to update your existing API Gateway solution. In this microlearning, we will focus on updating the Design phase of your API Gateway (and the subsequent steps) and we will focus on updating the Create phase of your API Gateway (and the subsequent steps). This to learn the impact of updates and to learn how we can achieve this.
4 4  
5 5  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
6 6  
8 +* Last update: June 28th, 2021
9 +* Required reading time: 6 minutes
10 +
7 7  == 1. Prerequisites ==
8 8  
9 9  * Basic knowledge of the eMagiz platform
... ... @@ -18,6 +18,8 @@
18 18  * Updating can happen from Create
19 19  * Both situations have a different impact
20 20  
25 +
26 +
21 21  == 3. Updating your API Gateway Operations ==
22 22  
23 23  In our crash course on the API Gateway pattern, we have learned about setting up the API Gateway. However, we did not yet delve into the specifics of how to update your existing API Gateway solution. In this microlearning, we will focus on updating the Design phase of your API Gateway (and the subsequent steps) and we will focus on updating the Create phase of your API Gateway (and the subsequent steps). This to learn the impact of updates and to learn how we can achieve this.
... ... @@ -38,7 +38,7 @@
38 38  * When you change something to the configuration of the backend operation (i.e. endpoint, parameter, system request/response) the change will **only** impact the specific exit gate
39 39  * When you change the gateway request/response message (with transformation) the change will impact **both** the all-entry and the specific exit gate
40 40  
41 -In some cases, version bumps are needed to confirm the change in Create. For exit gates, this process is identical to when you do a version bump of any messaging flow after updating for example a CDM message or message mapping. However, when you update something on the all-entry level what is needed differs. In case of a security change you need to reset the all-entry flow. To reset a flow simply access the context menu on flow level in Create (via a right-mouse click) and press Reset flow. In case of all other changes, no reset is needed, just a version bump.
47 +In all cases, you need a version bump of the flow to which you can relate the change. For exit gates, this process is identical to when you do a version bump of any messaging flow after updating for example a CDM message or message mapping. However, when you update something on the all-entry level this becomes less simple. Because eMagiz does not only pre-configure the resources for you in Create but the complete all-entry flow you **need** a reset of the all-entry to reflect these changes. To reset a flow simply access the context menu on flow level in Create (via a right-mouse click) and press Reset flow.
42 42  
43 43  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--reset-flow-context-menu.png]]
44 44  
... ... @@ -66,8 +66,15 @@
66 66  
67 67  As is the case with all new versions in Create the changes will only be effectuated when you deploy your solution via the Deploy phase of eMagiz.
68 68  
69 -== 4. Key takeaways ==
70 70  
76 +
77 +== 4. Assignment ==
78 +
79 +Think of three changes you want to apply to an API Gateway solution and see if you can determine which flow in Create needs an update.
80 +This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
81 +
82 +== 5. Key takeaways ==
83 +
71 71  * Updating can happen from Design
72 72  * Updating can happen from Create
73 73  * Both situations have a different impact
... ... @@ -75,9 +75,14 @@
75 75  * Updating from Create does not involve a reset
76 76  * Updating from Design involves a reset
77 77  
78 -== 5. Suggested Additional Readings ==
79 79  
92 +
93 +== 6. Suggested Additional Readings ==
94 +
80 80  If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
81 81  
97 +== 7. Silent demonstration video ==
82 82  
99 +As this is a more theoretical microlearning we did not provide a video for this one.
100 +
83 83  )))((({{toc/}}))){{/container}}{{/container}}