Skip to Content
Last modified by Danniar Firdausy on 2024/09/30 17:12
From version 24.1
edited by Erik Bakker
on 2022/08/29 14:41
Change comment: There is no comment for this version
To version 28.1
edited by Erik Bakker
on 2024/06/24 11:11
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,6 +1,6 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 2  
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.
3 +In our [[crash course>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]] 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  
... ... @@ -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 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.
42 42  
43 43  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--reset-flow-context-menu.png]]
44 44  
... ... @@ -46,15 +46,6 @@
46 46  
47 47  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--reset-flow-warning.png]]
48 48  
49 -After you reset your all-entry eMagiz will update the following:
50 -
51 -* Swagger UI that is shown to clients via the Swagger documentation page
52 -* Parameter references
53 -* Error Handling
54 -* Many more
55 -
56 -This all depends on which changes you **made** on the Design level.
57 -
58 58  === 3.2 Updating from Create ===
59 59  
60 60  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:
... ... @@ -66,13 +66,8 @@
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. Assignment ==
60 +== 4. Key takeaways ==
70 70  
71 -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.
72 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
73 -
74 -== 5. Key takeaways ==
75 -
76 76  * Updating can happen from Design
77 77  * Updating can happen from Create
78 78  * Both situations have a different impact
... ... @@ -80,14 +80,9 @@
80 80  * Updating from Create does not involve a reset
81 81  * Updating from Design involves a reset
82 82  
69 +== 5. Suggested Additional Readings ==
83 83  
84 -
85 -== 6. Suggested Additional Readings ==
86 -
87 87  If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
88 88  
89 -== 7. Silent demonstration video ==
90 90  
91 -As this is a more theoretical microlearning we did not provide a video for this one.
92 -
93 93  )))((({{toc/}}))){{/container}}{{/container}}