Skip to Content

Changing the default messaging format to XML

Version 2.5 by Bouke Reitsma on 2023/02/28 16:51

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.

Should you have any questions, please contact academy@emagiz.com.

1. Prerequisites

  • Basic knowledge of the eMagiz platform

2. Key concepts

There are no specific concepts to consider for now that require additional explanation.

3. Changing the default messaging format

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, you can change the default messaging format to XML in your project. 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
 
  AFBEELDING 1 TOEVOEGEN

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.

Information

* Note Changing the default messaging format does not affect existing operations in create. Migrating these flows require a reset of the exit flow.

4. Impact in Create

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:

  • Changing the dataType (i.e. from dateTime to date)
  • Adding valid enum values

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.

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.

4. Assignment

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.
This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.

5. Key takeaways

  • Updating can happen from Design
  • Updating can happen from Create
  • Both situations have a different impact
  • Adding a new operation to an existing solution does not involve a reset
  • Updating from Create does not involve a reset
  • Updating from Design involves a reset

6. Suggested Additional Readings

If you are interested in this topic and want more information on it please read the help text provided by eMagiz.

7. Silent demonstration video

As this is a more theoretical microlearning we did not provide a video for this one.