Wiki source code of Configure A Backend Operation
Last modified by Eva Torken on 2023/06/08 11:36
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
20.1 | 1 | {{container}}{{container layoutStyle="columns"}}((( |
| |
1.1 | 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. | ||
| 4 | |||
| |
20.1 | 5 | Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]]. |
| |
1.1 | 6 | |
| 7 | == 1. Prerequisites == | ||
| 8 | |||
| 9 | * Basic knowledge of the eMagiz platform | ||
| 10 | |||
| 11 | == 2. Key concepts == | ||
| 12 | |||
| 13 | This microlearning centers around configuring a backend operation with the API Gateway solution of eMagiz. | ||
| |
27.1 | 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. | ||
| |
1.1 | 16 | |
| 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 | |||
| 19 | == 3. Configure a backend operation == | ||
| 20 | |||
| |
27.1 | 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. | ||
| |
1.1 | 23 | |
| |
27.1 | 24 | 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: |
| |
1.1 | 25 | |
| |
20.1 | 26 | [[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend-operations--system-edit.png]] |
| |
1.1 | 27 | |
| 28 | In here you need to fill in the technical name, just as with any other system. Furthermore, you have two decisions to make: | ||
| 29 | |||
| |
25.1 | 30 | * Does the system talk JSON or XML (i.e. which message format) |
| |
1.1 | 31 | * Can you specify the backend operations either via an import of the OpenAPI 3.0 spec or via a manual action |
| 32 | |||
| 33 | 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. | ||
| 34 | More on that later in this microlearning. | ||
| 35 | |||
| |
27.1 | 36 | 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: |
| |
1.1 | 37 | |
| |
20.1 | 38 | [[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend-operations--system-edit-xml-result.png]] |
| |
1.1 | 39 | |
| 40 | === 3.1 Importing a specification === | ||
| 41 | |||
| 42 | If the external party can provide you with an OpenAPI 3.0 specification you can manage your backend system by pressing the Import button | ||
| |
27.1 | 43 | when you are editing the system (double click on the system in question). |
| |
1.1 | 44 | |
| |
20.1 | 45 | [[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend-operations--system-edit-manage.png]] |
| |
1.1 | 46 | |
| 47 | 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. | ||
| 48 | |||
| |
20.1 | 49 | [[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend-operations--import-open-api-pop-up.png]] |
| |
1.1 | 50 | |
| 51 | 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. | ||
| |
27.1 | 52 | A result of such an import could be as follows: |
| |
1.1 | 53 | |
| |
20.1 | 54 | [[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend-operations--import-open-api-result.png]] |
| |
1.1 | 55 | |
| 56 | Congratulations you have successfully imported your OpenAPI 3.0 specification. | ||
| 57 | |||
| 58 | === 3.2 Creating a specification === | ||
| 59 | |||
| |
27.1 | 60 | It can very well be that the external party has a swagger definition, but not an OpenAPI 3.0 standard. |
| |
1.1 | 61 | Or maybe they have other documentation that tells you the resource paths, parameters, and HTTP operations that you need. |
| 62 | |||
| |
27.1 | 63 | 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). |
| |
1.1 | 64 | |
| |
20.1 | 65 | [[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend-operations--system-edit-manage.png]] |
| |
1.1 | 66 | |
| 67 | 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. | ||
| 68 | |||
| |
20.1 | 69 | [[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend--manage-pop-up.png]] |
| |
1.1 | 70 | |
| |
27.1 | 71 | 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. |
| 72 | 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: | ||
| |
1.1 | 73 | |
| |
20.1 | 74 | [[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend--manage-pop-up-resource-filled-in.png]] |
| |
1.1 | 75 | |
| |
27.1 | 76 | 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: |
| |
1.1 | 77 | |
| |
20.1 | 78 | [[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend--manage-pop-up-operation-filled-in.png]] |
| |
1.1 | 79 | |
| |
27.1 | 80 | 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. |
| |
1.1 | 81 | |
| |
20.1 | 82 | [[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-backend--pop-up-result.png]] |
| |
1.1 | 83 | |
| 84 | Now you can Save or add another operation to add to your specification. | ||
| 85 | |||
| 86 | === 3.3 Next steps === | ||
| 87 | |||
| 88 | 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. | ||
| 89 | 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. | ||
| 90 | |||
| |
29.1 | 91 | == 4. Key takeaways == |
| |
1.1 | 92 | |
| 93 | * The starting point of setting up your API Gateway is configuring the backend operation(s) | ||
| 94 | * There are two ways to do so for JSON based systems | ||
| 95 | * Import OpenAPI 3.0 specification | ||
| 96 | * Manually configure based on other specification | ||
| 97 | * Other cases such as connecting to XML based systems will be discussed later on | ||
| 98 | |||
| |
29.1 | 99 | == 5. Suggested Additional Readings == |
| |
1.1 | 100 | |
| 101 | If you are interested in this topic and want more information on it please read the help text provided by eMagiz. | ||
| 102 | |||
| 103 | |||
| |
20.1 | 104 | )))((({{toc/}}))){{/container}}{{/container}} |