Skip to Content
Last modified by Danniar Firdausy on 2024/09/30 17:12
From version 28.1
edited by Erik Bakker
on 2024/06/24 11:11
Change comment: There is no comment for this version
To version 29.2
edited by Danniar Firdausy
on 2024/08/07 10:53
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.dfirdausy
Content
... ... @@ -1,6 +1,6 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 2  
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.
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 still need to delve into 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 the create phase of your API gateway (and subsequent steps). This is to learn the impact of updates and 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  
... ... @@ -12,7 +12,7 @@
12 12  
13 13  This microlearning centers around updating your API Gateway.
14 14  
15 -By updating, we mean: Changing existing software to reflect new insights or ideas that have come up during development and/or testing
15 +By updating, we mean changing existing software to reflect new insights or ideas that have come up during development and testing.
16 16  
17 17  * Updating can happen from Design
18 18  * Updating can happen from Create
... ... @@ -20,43 +20,42 @@
20 20  
21 21  == 3. Updating your API Gateway Operations ==
22 22  
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.
23 +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 still need to delve into 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 the create phase of your API gateway (and subsequent steps). This is to learn the impact of updates and how we can achieve this.
24 24  
25 25  * Updating can happen from Design
26 26  * Updating can happen from Create
27 27  * Both situations have a different impact
28 28  
29 -In the remainder of this microlearning, we will discuss both scenarios. This to get clarity on what the impact is of both scenarios.
29 +In the remainder of this microlearning, we will discuss both scenarios to clarify their impact.
30 30  
31 31  === 3.1 Updating from Design ===
32 32  
33 -After you have already added an integration to Create you might want to change the error handling, the structure of the request and/or response message, the parameters, etc. In all these scenarios you need to change something in the Design phase of eMagiz. The actual changing of these parts of the API Gateway solutions is specified in earlier microlearnings. However, what to do after you have made those changes is not yet discussed. In this microlearning, we will discuss that process within eMagiz. Note that this process **only** applies when the operation already exists in Create. If it does not yet exist in Create eMagiz will simply add the configuration to the existing flow without changing the remainder of the all-entry.
33 +After adding an integration to Create, you can change the error handling, the request and response message structure, the parameters, and more. In all these scenarios, you need to change something in the Design phase of eMagiz. The actual change in these parts of the API Gateway solutions is specified in earlier microlearnings. However, what to do after you have made those changes has yet to be discussed. In this microlearning, we will discuss that process within eMagiz. Note that this process **only** applies when the operation already exists in Create. If it does not yet exist in Create, eMagiz will create a new entry and exit gate for you based on the configuration in Design.
34 34  
35 -As you might know from our offering on the messaging pattern and how to update in those scenarios you can imagine that (parts of) the API Gateway flows need to be updated to reflect your changes. Depending on the exact change the effect will be seen in the 'all entry' or in one of the exit gates that is specific to an operation. The division can be made as follows:
35 +From our offering on the messaging pattern and how to update it in those scenarios, you can imagine that (parts of) the API Gateway flows need to be updated to reflect your changes. Depending on the exact change, the effect will be seen in the corresponding entry gate or the corresponding exit gate specific to an operation. The division can be made as follows:
36 36  
37 -* When you change something to the configuration of the API Gateway itself (i.e security, error handling, parameters) the change will **only** impact the all-entry
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 -* When you change the gateway request/response message (with transformation) the change will impact **both** the all-entry and the specific exit gate
37 +* When you change something in the configuration of the API Gateway operation itself (e.g., path, error handling, parameters), the change will only impact the corresponding entry gate.
38 +* When you change something in the configuration of the backend operation (i.e., endpoint, parameter, system request/response), the change will only impact the specific exit gate.
39 +* When you change the gateway request/response message (with transformation), the change will impact **both** the entry gate and the specific exit gate.
40 +* When you change the API Gateway's security configuration, the infra flow and all entry gates will be updated (by clicking on Update security in the context menu).
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.
42 +eMagiz will automate all changes on the entry gate level except for changing the security configuration due to the impact of such a change. When the change is executed, eMagiz will automatically create a new version of the entry gate to reflect the change. To update changes in the exit gate, you need to execute a manual version bump. This division is made because the exit gate can contain much more customization, while the entry gate is, in most cases, completely generated by eMagiz.
42 42  
43 -[[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--reset-flow-context-menu.png]]
44 +=== 3.2 Updating from Create ===
44 44  
45 -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.
46 +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 particular 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:
46 46  
47 -[[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--reset-flow-warning.png]]
48 +* Changing the dataType (i.e., from dateTime to date)
49 +* Changing / Adding / Deleting valid enum values
48 48  
49 -=== 3.2 Updating from Create ===
51 +In both cases, eMagiz will automatically update your Swagger definition by recreating it to reflect these changes and executing a version bump of the infra flow.
50 50  
51 -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:
53 +=== 3.3 Updating the Swagger UI ===
52 52  
53 -* Changing the dataType (i.e. from dateTime to date)
54 -* Adding valid enum values
55 +As is the case with all new versions in Create, the changes will only be effective when you deploy your solution via the eMagiz Deploy phase.
55 55  
56 -In both cases, eMagiz will automatically update your Swagger definition and all-entry flow by recreating the swagger definition to reflect these changes and executing a version bump of the all-entry.
57 +{{info}}To ensure that the changes to your Swagger file generated by eMagiz are shown to the end-user, the latest version of the API Gateway runtime infra flow needs to be included in the release and deployed to the correct environment.{{/info}}
57 57  
58 -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.
59 -
60 60  == 4. Key takeaways ==
61 61  
62 62  * Updating can happen from Design
... ... @@ -64,11 +64,13 @@
64 64  * Both situations have a different impact
65 65  * Adding a new operation to an existing solution does not involve a reset
66 66  * Updating from Create does not involve a reset
67 -* Updating from Design involves a reset
66 +* Updating from Design does not involve a reset
68 68  
69 69  == 5. Suggested Additional Readings ==
70 70  
71 -If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
70 +If you are interested in this topic and want more information, please read the help text provided by eMagiz and the following link.
71 +* [[Crash Course (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
72 +** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]]
73 +*** [[Swagger UI (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-swagger-ui||target="blank"]]
72 72  
73 -
74 74  )))((({{toc/}}))){{/container}}{{/container}}