Last modified by Danniar Firdausy on 2024/09/30 17:12

From version 16.1
edited by eMagiz
on 2022/05/17 08:33
Change comment: There is no comment for this version
To version 27.1
edited by Eva Torken
on 2023/08/25 11:31
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Updating your API Gateway Operations
Parent
... ... @@ -1,0 +1,1 @@
1 +WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.marijn
1 +XWiki.etorken
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -1,20 +1,9 @@
1 -{{html wiki="true"}}
2 -<div class="ez-academy">
3 - <div class="ez-academy_body">
1 +{{container}}{{container layoutStyle="columns"}}(((
4 4  
5 -<div class="doc">
6 -
7 -
8 -
9 -= Updating your API Gateway Operations =
10 -
11 11  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.
12 12  
13 -Should you have any questions, please contact academy@emagiz.com.
5 +Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
14 14  
15 -* Last update: June 28th, 2021
16 -* Required reading time: 6 minutes
17 -
18 18  == 1. Prerequisites ==
19 19  
20 20  * Basic knowledge of the eMagiz platform
... ... @@ -29,8 +29,6 @@
29 29  * Updating can happen from Create
30 30  * Both situations have a different impact
31 31  
32 -
33 -
34 34  == 3. Updating your API Gateway Operations ==
35 35  
36 36  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.
... ... @@ -51,23 +51,14 @@
51 51  * 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
52 52  * When you change the gateway request/response message (with transformation) the change will impact **both** the all-entry and the specific exit gate
53 53  
54 -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.
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.
55 55  
56 -<p align="center">[[image:intermediate-api-management-updating-your-api-gateway-operations--reset-flow-context-menu.png||]]</p>
43 +[[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--reset-flow-context-menu.png]]
57 57  
58 58  After you press this option eMagiz will present you with a confirmation pop-up to ensure that you are 100% sure that this is the correct flow that you want to reset. This because resetting a flow means returning to the original state.
59 59  
60 -<p align="center">[[image:intermediate-api-management-updating-your-api-gateway-operations--reset-flow-warning.png||]]</p>
47 +[[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--reset-flow-warning.png]]
61 61  
62 -After you reset your all-entry eMagiz will update the following:
63 -
64 -* Swagger UI that is shown to clients via the Swagger documentation page
65 -* Parameter references
66 -* Error Handling
67 -* Many more
68 -
69 -This all depends on which changes you **made** on the Design level.
70 -
71 71  === 3.2 Updating from Create ===
72 72  
73 73  Apart from updating your API Gateway solution in Create, you can only update parts of the API Gateway solution in Create. Here we mainly talk about changing the gateway messages. Any other changes on the 'exit gate' level have no special impact compared to changing parts of other flows. We discern two parts of updating a (gateway) message that you can execute in the Create phase:
... ... @@ -79,15 +79,8 @@
79 79  
80 80  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.
81 81  
82 -===== Practice =====
60 +== 4. Key takeaways ==
83 83  
84 -== 4. Assignment ==
85 -
86 -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.
87 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
88 -
89 -== 5. Key takeaways ==
90 -
91 91  * Updating can happen from Design
92 92  * Updating can happen from Create
93 93  * Both situations have a different impact
... ... @@ -95,19 +95,9 @@
95 95  * Updating from Create does not involve a reset
96 96  * Updating from Design involves a reset
97 97  
69 +== 5. Suggested Additional Readings ==
98 98  
99 -
100 -== 6. Suggested Additional Readings ==
101 -
102 102  If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
103 103  
104 -== 7. Silent demonstration video ==
105 105  
106 -As this is a more theoretical microlearning we did not provide a video for this one.
107 -
108 -</div>
109 -
110 -</div>
111 -</div>
112 -
113 -{{/html}}
74 +)))((({{toc/}}))){{/container}}{{/container}}