Skip to Content
Last modified by Erik Bakker on 2024/08/23 11:32
From version 36.1
edited by Erik Bakker
on 2024/08/23 11:32
Change comment: There is no comment for this version
To version 28.1
edited by Eva Torken
on 2023/04/20 11:27
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.etorken
Content
... ... @@ -1,7 +1,8 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -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.
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.
3 3  
4 -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]].
5 5  
6 6  == 1. Prerequisites ==
7 7  
... ... @@ -10,15 +10,15 @@
10 10  == 2. Key concepts ==
11 11  
12 12  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.
13 13  
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.
16 -
17 17  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.
18 18  
19 19  == 3. Configure a backend operation ==
20 20  
21 -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.
22 22  
23 23  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:
24 24  
... ... @@ -26,7 +26,7 @@
26 26  
27 27  In here you need to fill in the technical name, just as with any other system. Furthermore, you have two decisions to make:
28 28  
29 -* 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)
30 30  * Can you specify the backend operations either via an import of the OpenAPI 3.0 spec or via a manual action
31 31  
32 32  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.
... ... @@ -87,8 +87,13 @@
87 87  After you have correctly configured your backend operation you can start to think about how you can best expose the operations via the API Gateway.
88 88  In the next three microlearnings, we will delve deeper into the various components and also learn how you can quickly expose these backend operations in your API Gateway.
89 89  
90 -== 4. Key takeaways ==
91 +== 4. Assignment ==
91 91  
93 +Manually configure a GET operation with the resource path /httpmethods in an API Gateway system.
94 +This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
95 +
96 +== 5. Key takeaways ==
97 +
92 92  * The starting point of setting up your API Gateway is configuring the backend operation(s)
93 93  * There are two ways to do so for JSON based systems
94 94   * Import OpenAPI 3.0 specification
... ... @@ -95,24 +95,14 @@
95 95   * Manually configure based on other specification
96 96  * Other cases such as connecting to XML based systems will be discussed later on
97 97  
98 -== 5. Suggested Additional Readings ==
104 +== 6. Suggested Additional Readings ==
99 99  
100 -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:
106 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
101 101  
102 -* [[Crash Course (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||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"]]
105 -*** [[Parameters (Path, Query) (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-parameters||target="blank"]]
106 -*** [[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 exit gate (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-setting-up-exit-gate||target="blank"]]
108 -*** [[Data type transformations (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-data-type-transformations||target="blank"]]
109 -* [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
110 -** [[Configuring the API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Configuring the API Gateway.WebHome||target="blank"]]
111 -*** [[Transforming messages in API Gateways (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Configuring the API Gateway.intermediate-configuring-the-api-gateway-transforming-messages||target="blank"]]
112 -** [[API Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.API Management.WebHome||target="blank"]]
113 -*** [[Updating your API Gateway Operations (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.API Management.intermediate-api-management-updating-your-api-gateway-operations||target="blank"]]
114 -* [[Advanced Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
115 -** [[API Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.API Management.WebHome||target="blank"]]
116 -*** [[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"]]
117 -* [[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"]]
108 +== 7. Silent demonstration video ==
109 +
110 +This video demonstrates how you could have handled the assignment and gives you some context on what you have just learned. Disclaimer, you only see the eMagiz part but if you follow the above steps you are good to go!
111 +
112 +{{video attachment="crashcourse-api-gateway-configure-backend-operation.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
113 +
118 118  )))((({{toc/}}))){{/container}}{{/container}}