Skip to Content
Last modified by Danniar Firdausy on 2024/09/18 13:34
From version 2.3
edited by Bouke Reitsma
on 2023/02/28 16:35
Change comment: There is no comment for this version
To version 16.1
edited by Carlijn Kokkeler
on 2024/08/08 14:56
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Changing the default messaging format to XML
1 +Changing the default messaging format
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.BoukeReitsma
1 +XWiki.CarlijnKokkeler
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. By default, the messaging format chosen for your gateway is json. However, in some instances XML is more appropriate as default message format. In this microlearning, we focus on changing the default message format and show the impact this has on flows in Create.
3 +In our crash course on the API Gateway pattern, we have learned about setting up the API Gateway. By default, the messaging format chosen for your gateway is JSON. However, in some instances, other message formats are more appropriate as default. In this microlearning, we focus on changing the default message format and show the impact this has on flows in Create.
4 4  
5 5  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
6 6  
... ... @@ -14,44 +14,30 @@
14 14  
15 15  == 3. Changing the default messaging format ==
16 16  
17 -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.
17 +In our crash course on the API Gateway pattern, we have learned about setting up the API Gateway. By default, the messaging format selected for your gateway is JSON. However, the default messaging format can be changed in your project to for example, XML. This change can be made in Design -> Settings -> API Management. On the right side of this overview are the gateway settings. The last entry of this overview is the Default Format. By clicking on the Edit settings button, you enter the following overview
18 18  
19 -{{info}}~* Note Changing the default messaging format does not affect existing operations in create. Migrating these flows require a reset of the exit flow.{{/info}}
19 +[[image:Main.Images.Microlearning.WebHome@intermediate-api-management-changing-default-messaging-format--edit-settings.png]]
20 20  
21 +The last option allows you to switch between JSON or XML as your default messaging format in the gateway. In order to apply your new default to your project, you must press "Apply settings" in Design -> Architecture to confirm your change~*.
21 21  
22 -== 4. Impact in Create ==
23 +{{info}}~* Note Changing the default messaging format does not affect existing operations in Create. Migrating these flows requires a reset of the exit flow. Additionally, the default response in Catalog has to be changed to application/xml. {{/info}}
23 23  
24 -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:
25 +== 3.1 Impact in Create ==
25 25  
26 -* Changing the dataType (i.e. from dateTime to date)
27 -* Adding valid enum values
27 +After the flows are resetted in Create, the automatic flow creation in the Create phase is adapted to the new default setting. When changing the messaging format to XML, the components of newly generated flows are created with different names and settings. The image below shows an example of an API GET operation with XML as the default messaging format. Besides the changed naming of the transformation, no JSON factory support objects are required in your flow in comparison with a JSON messaging format.
28 28  
29 -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.
29 +[[image:Main.Images.Microlearning.WebHome@intermediate-api-management-changing-default-messaging-format--get-operation.png]]
30 30  
31 -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.
31 +== 4. Key takeaways ==
32 32  
33 -== 4. Assignment ==
33 +* The default messaging format can be changed to XML
34 +* Updating this only affects new flows
35 +* Migrating existing operations can be done by resetting the exit flow
34 34  
35 -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.
36 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
37 +== 5. Suggested Additional Readings ==
37 37  
38 -== 5. Key takeaways ==
39 +* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-defining-a-message-format||target="blank"]]
40 +** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
41 +*** [[Defining a message format (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-defining-a-message-format||target="blank"]]
39 39  
40 -* Updating can happen from Design
41 -* Updating can happen from Create
42 -* Both situations have a different impact
43 -* Adding a new operation to an existing solution does not involve a reset
44 -* Updating from Create does not involve a reset
45 -* Updating from Design involves a reset
46 -
47 -
48 -
49 -== 6. Suggested Additional Readings ==
50 -
51 -If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
52 -
53 -== 7. Silent demonstration video ==
54 -
55 -As this is a more theoretical microlearning we did not provide a video for this one.
56 -
57 57  )))((({{toc/}}))){{/container}}{{/container}}