Skip to Content
Last modified by Danniar Firdausy on 2024/09/18 13:34
From version 16.11
edited by Danniar Firdausy
on 2024/09/18 13:34
Change comment: There is no comment for this version
To version 9.3
edited by Bouke Reitsma
on 2023/03/03 13:17
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Changing the default message format
1 +Changing the default messaging format to XML
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.dfirdausy
1 +XWiki.BoukeReitsma
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 explored how to set up an API Gateway with JSON as the default message format. However, there are situations where other formats, like XML, may be more suitable. This microlearning will guide you through changing the default message format and explain how this adjustment impacts the flow creation process 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  
... ... @@ -20,31 +20,32 @@
20 20  
21 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~*.
22 22  
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 +{{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.
24 + {{/info}}
24 24  
25 -== 3.1 Impact in Create ==
26 +== 4. Impact in Create ==
26 26  
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 +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 29  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-changing-default-messaging-format--get-operation.png]]
30 30  
31 -== 4. Key takeaways ==
32 +== 4. Assignment ==
32 32  
33 -* The default messaging format for your API Gateway can be changed, such as from JSON to XML, in the gateway settings.
34 -* This change only affects newly created flows; existing flows remain unchanged unless manually updated.
35 -* To migrate existing flows to the new default format, reset the exit flow and update the default response format in Catalog.
36 -* Changing the default format simplifies flow creation by adjusting component names and settings to match the selected format (e.g., XML).
34 +Change the default messaging format to XML.
35 +This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
37 37  
38 -== 5. Suggested Additional Readings ==
37 +== 5. Key takeaways ==
39 39  
40 -If you are interested in this topic and want more information, please read the help text provided by eMagiz and see the following link:
39 +* The default messaging format can be changed to XML
40 +* Updating this only affects new flows
41 +* Migrating existing operations can be done by resetting the exit flow
41 41  
42 -* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-defining-a-message-format||target="blank"]]
43 -** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
44 -*** [[Defining a message format (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-defining-a-message-format||target="blank"]]
45 -* [[Novice Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
46 -** [[Create your transformations (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Create your transformations.WebHome||target="blank"]]
47 -*** [[Transformation - XML to JSON (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Create your transformations.novice-create-your-transformations-xml-to-json||target="blank"]]
48 -*** [[Transformation - JSON to XML (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.Create your transformations.novice-create-your-transformations-json-to-xml||target="blank"]]
49 -* [[Changing the default message format (Search Results)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&l_space_facet=10&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22changing+the+default+message+format%22||target="blank"]]
43 +== 6. Suggested Additional Readings ==
44 +
45 +If you are interested in this topic and want more information on it, please read the help text provided by eMagiz.
46 +
47 +== 7. Silent demonstration video ==
48 +
49 +To be recorded.
50 +
50 50  )))((({{toc/}}))){{/container}}{{/container}}