Skip to Content
Last modified by Erik Bakker on 2024/08/23 11:32
From version 19.1
edited by eMagiz
on 2022/05/05 16:38
Change comment: There is no comment for this version
To version 23.1
edited by Erik Bakker
on 2022/08/11 10:49
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Configure a backend operation
Parent
... ... @@ -1,0 +1,1 @@
1 +WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.marijn
1 +XWiki.ebakker
Content
... ... @@ -1,21 +1,9 @@
1 -{{html wiki="true"}}
2 -<div class="ez-academy">
3 - <div class="ez-academy_body">
4 -
5 -<div class="doc">
6 -
7 -
8 -
9 -= Configure a backend operation =
10 -
1 +{{container}}{{container layoutStyle="columns"}}(((
11 11  In this microlearning, we will focus on learning about how you can correctly configure the backend operations.
12 12  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.
13 13  
14 -Should you have any questions, please contact academy@emagiz.com.
5 +Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
15 15  
16 -* Last update: April 14th, 2021
17 -* Required reading time: 6 minutes
18 -
19 19  == 1. Prerequisites ==
20 20  
21 21  * Basic knowledge of the eMagiz platform
... ... @@ -28,8 +28,6 @@
28 28  
29 29  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.
30 30  
31 -
32 -
33 33  == 3. Configure a backend operation ==
34 34  
35 35  When you look at the conceptual idea of the API Gateway, exposing backend operations via a centralized location to the outside world
... ... @@ -37,7 +37,7 @@
37 37  
38 38  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
39 39  
40 -<p align="center">[[image:crashcourse-api-gateway-configure-backend-operations--system-edit.png||]]</p>
26 +[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend-operations--system-edit.png]]
41 41  
42 42  In here you need to fill in the technical name, just as with any other system. Furthermore, you have two decisions to make:
43 43  
... ... @@ -49,7 +49,7 @@
49 49  
50 50  In case the answer to the first decision is XML you should switch the default format to XML and unselect the OpenAPI 3.0 spec. The result should be something like this.
51 51  
52 -<p align="center">[[image:crashcourse-api-gateway-configure-backend-operations--system-edit-xml-result.png||]]</p>
38 +[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend-operations--system-edit-xml-result.png]]
53 53  
54 54  === 3.1 Importing a specification ===
55 55  
... ... @@ -56,16 +56,16 @@
56 56  If the external party can provide you with an OpenAPI 3.0 specification you can manage your backend system by pressing the Import button
57 57  when you are editing the system (double click on the system in question)
58 58  
59 -<p align="center">[[image:crashcourse-api-gateway-configure-backend-operations--system-edit-manage.png||]]</p>
45 +[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend-operations--system-edit-manage.png]]
60 60  
61 61  After you have pressed the Import button you enter the following pop-up. Here you can select the OpenAPI 3.0 JSON file to be imported in eMagiz.
62 62  
63 -<p align="center">[[image:crashcourse-api-gateway-configure-backend-operations--import-open-api-pop-up.png||]]</p>
49 +[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend-operations--import-open-api-pop-up.png]]
64 64  
65 65  Press Import and let eMagiz do the heavy lifting for you. eMagiz will now import all backend operations that are specified in the OpenAPI 3.0 JSON file you have selected.
66 66  A result of such an import could be as follows.
67 67  
68 -<p align="center">[[image:crashcourse-api-gateway-configure-backend-operations--import-open-api-result.png||]]</p>
54 +[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend-operations--import-open-api-result.png]]
69 69  
70 70  Congratulations you have successfully imported your OpenAPI 3.0 specification.
71 71  
... ... @@ -76,24 +76,24 @@
76 76  
77 77  In all these cases you can manage your backend system by pressing the Manage button when you are editing the system (double click on the system in question)
78 78  
79 -<p align="center">[[image:crashcourse-api-gateway-configure-backend-operations--system-edit-manage.png||]]</p>
65 +[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend-operations--system-edit-manage.png]]
80 80  
81 81  When you select the option Manage you will be presented with the following pop-up. The first time this pop-up will be empty. All other times it should contain at least one backend operation.
82 82  
83 -<p align="center">[[image:crashcourse-api-gateway-configure-backend--manage-pop-up.png||]]</p>
69 +[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend--manage-pop-up.png]]
84 84  
85 85  Let us manually fill a simple GET call to retrieve all HTTP methods. So we start at the top left of the screen in the resource section and press New.
86 86  In the pop-up that follows we enter the resource path that is defined in the specification and press Save. The result will be as follows.
87 87  
88 -<p align="center">[[image:crashcourse-api-gateway-configure-backend--manage-pop-up-resource-filled-in.png||]]</p>
74 +[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend--manage-pop-up-resource-filled-in.png]]
89 89  
90 90  The next step will be to add an operation via the option New under Operations in the middle of your screen. The result of that action will be something as follows.
91 91  
92 -<p align="center">[[image:crashcourse-api-gateway-configure-backend--manage-pop-up-operation-filled-in.png||]]</p>
78 +[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend--manage-pop-up-operation-filled-in.png]]
93 93  
94 94  As there are no parameters in this case you have now successfully configured your first backend operation. When you close this screen you will see the results on system level
95 95  
96 -<p align="center">[[image:crashcourse-api-gateway-configure-backend--pop-up-result.png||]]</p>
82 +[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend--pop-up-result.png]]
97 97  
98 98  Now you can Save or add another operation to add to your specification.
99 99  
... ... @@ -102,8 +102,6 @@
102 102  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.
103 103  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.
104 104  
105 -===== Practice =====
106 -
107 107  == 4. Assignment ==
108 108  
109 109  Manually configure a GET operation with the resource path /httpmethods in an API Gateway system.
... ... @@ -117,8 +117,6 @@
117 117   * Manually configure based on other specification
118 118  * Other cases such as connecting to XML based systems will be discussed later on
119 119  
120 -
121 -
122 122  == 6. Suggested Additional Readings ==
123 123  
124 124  If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
... ... @@ -127,10 +127,6 @@
127 127  
128 128  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!
129 129  
130 -<iframe width="1280" height="720" src="../../vid/microlearning/crashcourse-api-gateway-configure-backend-operation.mp4" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
112 +{{video attachment="crashcourse-api-gateway-configure-backend-operation.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
131 131  
132 -</div>
133 -</div>
134 -</div>
135 -
136 -{{/html}}
114 +)))((({{toc/}}))){{/container}}{{/container}}