Changing the default messaging format to XML

{{container}}{{container layoutStyle="columns"}}(((

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.

4

5

Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].

6

7

== 1. Prerequisites ==

8

9

* Basic knowledge of the eMagiz platform

10

11

== 2. Key concepts ==

12

13

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

14

15

== 3. Changing the default messaging format ==

16

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, 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

18

19

AFBEELDING 1 TOEVOEGEN

{{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}}

24

25

26

== 4. Impact in Create ==

27

28

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:

29

30

* Changing the dataType (i.e. from dateTime to date)

31

* Adding valid enum values

32

33

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.

34

35

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.

40

This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.

41