Skip to Content
Last modified by Waria on 2026/09/03 10:18
From version 36.2
edited by Waria
on 2026/09/03 10:17
Change comment: Renamed back-links.
To version 32.1
edited by dfirdausy
on 2024/08/07 12:57
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.waria
1 +XWiki.dfirdausy
Content
... ... @@ -1,9 +1,8 @@
1 -{{container}}
2 -{{container layoutStyle="columns"}}
3 -(((
4 -In this microlearning, we will explore how to correctly configure backend operations within your API Gateway. Understanding how to properly set up these operations is crucial for effectively utilizing RESTful services and making these backend operations accessible through your API Gateway.
1 +{{container}}{{container layoutStyle="columns"}}(((
2 +In this microlearning, we will focus on learning about how you can correctly configure the backend operations.
3 +A crucial part of setting up your (API) Gateway with the help of RESTful services is knowing which backend operations you want to expose with the help of the API Gateway.
5 5  
6 -If you have any questions along the way, feel free to reach out to us at [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 +Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
7 7  
8 8  == 1. Prerequisites ==
9 9  
... ... @@ -12,15 +12,15 @@
12 12  == 2. Key concepts ==
13 13  
14 14  This microlearning centers around configuring a backend operation with the API Gateway solution of eMagiz.
14 +With backend operation we mean: Any action that is available to be executed on an internal system that you want to make publicly available via the API Gateway.
15 +With API Gateway we mean: A collection of RESTful API operations that can be published to the outside world to give them access to applications that are linked to your business process.
15 15  
16 -* With backend operation we mean: Any action that is available to be executed on an internal system that you want to make publicly available via the API Gateway.
17 -* With API Gateway we mean: A collection of RESTful API operations that can be published to the outside world to give them access to applications that are linked to your business process.
18 -
19 19  When setting up your API Gateway integration the process of doing things is to start at the backend operation and based on that expose an operation in the API Gateway.
20 20  
21 21  == 3. Configure a backend operation ==
22 22  
23 -The core concept of an API Gateway is to serve as an interface that centralizes and exposes backend operations to the outside world. It is then logical that, when you set up your API Gateway (i.e., the frontend facing part), you first start with the backend operation you want to expose.
21 +When you look at the conceptual idea of the API Gateway, exposing backend operations via a centralized location to the outside world.
22 +It stands to reason that when you set up your API Gateway (i.e. the front-end facing part) you start with the backend operation you want to expose.
24 24  
25 25  Configuring backend operations is done in the Design phase of eMagiz. When you are in the Design overview you can double click on the backend system that holds the operation(s). This action will show you the following pop-up:
26 26  
... ... @@ -28,7 +28,7 @@
28 28  
29 29  In here you need to fill in the technical name, just as with any other system. Furthermore, you have two decisions to make:
30 30  
31 -* Does the system talk JSON or XML (i.e., which message format)
30 +* Does the system talk JSON or XML (i.e. which message format)
32 32  * Can you specify the backend operations either via an import of the OpenAPI 3.0 spec or via a manual action
33 33  
34 34  If the answer to the above decisions is JSON and yes the default settings are correct you should continue to either import the OpenAPI 3.0 spec or manually configure at least one backend operation.
... ... @@ -93,19 +93,19 @@
93 93  
94 94  * The starting point of setting up your API Gateway is configuring the backend operation(s)
95 95  * There are two ways to do so for JSON based systems
96 -* Import OpenAPI 3.0 specification
97 -* Manually configure based on other specification
95 + * Import OpenAPI 3.0 specification
96 + * Manually configure based on other specification
98 98  * Other cases such as connecting to XML based systems will be discussed later on
99 99  
100 100  == 5. Suggested Additional Readings ==
101 101  
102 102  If you are interested in this topic and want more information on it please read the help text provided by eMagiz and read the following links:
103 -
104 104  * [[Crash Course (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
105 -** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]]
106 -*** [[HTTP Operations (Explanation)>>doc:crashcourse-api-gateway-designing-your-api-gateway||target="blank"]]
103 +** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]]
104 +*** [[HTTP Operations (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-http-operations||target="blank"]]
107 107  *** [[Parameters (Path, Query) (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-parameters||target="blank"]]
108 108  *** [[Error Handling from a client perspective (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-error-handling-from-a-client-perspective||target="blank"]]
107 +*** [[Setting up entry gate (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-setting-up-entry-gate||target="blank"]]
109 109  *** [[Setting up exit gate (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-setting-up-exit-gate||target="blank"]]
110 110  *** [[Data type transformations (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-data-type-transformations||target="blank"]]
111 111  * [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
... ... @@ -117,10 +117,4 @@
117 117  ** [[API Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.API Management.WebHome||target="blank"]]
118 118  *** [[Running part of your API Gateway solution on-premise (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.API Management.advanced-api-management-running-part-of-your-api-gateway-solution-on-premise||target="blank"]]
119 119  * [[Configure A Backend Operation (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=%22Configure+Backend+Operation%22||target="blank"]]
120 -)))
121 -
122 -(((
123 -{{toc/}}
124 -)))
125 -{{/container}}
126 -{{/container}}
119 +)))((({{toc/}}))){{/container}}{{/container}}