Last modified by Eva Torken on 2023/08/24 13:39
Show last authors
1 {{container}}{{container layoutStyle="columns"}}(((
2 In the crash course on API Gateway, we learned the basics of the API Gateway pattern. Then, we focused on what we call passthrough cases. Now, we will focus on transforming messages between the front end and the backend of the API Gateway. We will see that the functionality is similar compared to what we see within other patterns.
3
4 Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5
6 == 1. Prerequisites ==
7
8 * Intermediate knowledge of the eMagiz platform
9 * Basic knowledge of the API Gateway pattern
10
11 == 2. Key concepts ==
12
13 This microlearning is about transforming messages within the API Gateway pattern.
14
15 By transforming messages, we mean: Changing the structure of the data from what you receive to what you want to send to the backend operation.
16
17 Interesting points to consider are:
18
19 * The transformation process works similarly across patterns
20 * The benefit of having the transformation capability is that it expands the capabilities of the API Gateway. This fact makes it more attractive to use the eMagiz API Gateway
21 * You can transform from the different messaging formats (including itself) with the standard transformation functionality (for the API Gateway)
22
23 == 3. Transforming messages ==
24
25 In the crash course on API Gateway, we learned the basics of the API Gateway pattern. Then, we focused on what we call passthrough cases. Now, we will focus on transforming messages between the front end and the backend of the API Gateway. We will see that the functionality is similar compared to what we see within other patterns.
26
27 Interesting points to consider are:
28
29 * The transformation process works similarly across patterns
30 * The benefit of having the transformation capability is that it expands the capabilities of the API Gateway. This fact makes it more attractive to use the eMagiz API Gateway
31 * You can transform from the different messaging formats (including itself) with the standard transformation functionality (for the API Gateway)
32
33 As the transformation process works the same across patterns, it is pointless to discuss the message mapping again in this microlearning. If you would like to learn more about message mapping, please check out the [[Crash Course Platform Module>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]. To enable the transformation capabilities of the API Gateway, you can determine on operation level which type of integration you want (passthrough or transformation).
34
35 [[image:Main.Images.Microlearning.WebHome@intermediate-configuring-the-api-gateway-transforming-messages--operation-options-transformation.png]]
36
37 As you have probably noticed, you do not have to select a backend operation if you choose the transformation option. The backend can now also represent a SOAP web service, a database, or something else that gives back a response after the message is delivered to it.
38
39 After you have moved the operation to Create, you can edit the Create transformation in the same manner as you are used to within other patterns, and all possibilities will be the same.
40
41 == 4. Key takeaways ==
42
43 * The transformation process works similarly across patterns
44 * The benefit of having the transformation capability is that it expands the capabilities of the API Gateway. This fact makes it more attractive to use the eMagiz API Gateway
45 * You can transform from the different messaging formats (including itself) with the standard transformation functionality (for the API Gateway)
46 * To activate the transformation capabilities, you should select the Transformation option on the operation level in the Design phase.
47
48 == 5. Suggested Additional Readings ==
49
50 If you are interested in this topic and want more information on it, please read the release notes provided by eMagiz
51
52 )))((({{toc/}}))){{/container}}{{/container}}