Changes for page Setting up exit gate
Last modified by Danniar Firdausy on 2024/09/04 16:15
From version 11.1
edited by eMagiz
on 2022/05/05 16:41
on 2022/05/05 16:41
Change comment:
There is no comment for this version
To version 23.24
edited by Danniar Firdausy
on 2024/08/21 11:47
on 2024/08/21 11:47
Change comment:
There is no comment for this version
Summary
-
Page properties (5 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,0 +1,1 @@ 1 +Setting up exit gate - Parent
-
... ... @@ -1,0 +1,1 @@ 1 +WebHome - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. marijn1 +XWiki.dfirdausy - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Content
-
... ... @@ -1,21 +1,8 @@ 1 -{{html wiki="true"}} 2 -<div class="ez-academy"> 3 - <div class="ez-academy_body"> 1 +{{container}}{{container layoutStyle="columns"}}((( 2 +In this microlearning, we will walk you through how to configure the exit gate, which ensures seamless message delivery between the API Gateway and your backend operations. We will cover the essential parts from basic concepts to practical steps, so you will know exactly how to configure an exit gate to deliver incoming requests and give back responses to the client calling the API. 4 4 5 - <divclass="doc">4 +If you have any questions along the way, feel free to reach out to us at [[academy@emagiz.com>>mailto:academy@emagiz.com]]. 6 6 7 - 8 - 9 -= Setting up exit gate = 10 - 11 -In this microlearning, we will focus on setting up the exit gate for the API Gateway. 12 -This exit gate ensures that the message is delivered to the backend operation and that the response of the backend operation is given back to the client calling the API. 13 - 14 -Should you have any questions, please contact academy@emagiz.com. 15 - 16 -* Last update: February 11th, 2021 17 -* Required reading time: 3 minutes 18 - 19 19 == 1. Prerequisites == 20 20 21 21 * Basic knowledge of the eMagiz platform ... ... @@ -23,14 +23,14 @@ 23 23 == 2. Key concepts == 24 24 25 25 This microlearning centers around setting up the exit gate for the API Gateway solution of eMagiz. 13 + 26 26 With exit gate, we mean: The piece of functionality that connects to the backend operation to execute the action on behalf of the client that is calling the API 15 + 27 27 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 28 28 29 29 The exit gate is created by eMagiz based on the configuration in Design. In passthrough cases, you only need to add authentication. 30 -In cases of transformation, you need to specify the outbound component ( i.e. HTTP, Web service, JDBC, SFTP, etc.) and the authentication.19 +In cases of transformation, you need to specify the outbound component (e.g., HTTP, Web service, JDBC, SFTP, etc.) and the authentication. 31 31 32 - 33 - 34 34 == 3. Setting up exit gate == 35 35 36 36 Each backend operation has a specific exit gate that will handle all incoming traffic, connect to the backend operation and send the response back to the client that is calling the API. ... ... @@ -49,40 +49,42 @@ 49 49 50 50 In the most standard case, eMagiz will auto-generate the following flow for you 51 51 52 - <p align="center">[[image:crashcourse-api-gateway-configure-exit-gate--auto-generated-flow.png||]]</p>39 +[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-configure-exit-gate--auto-generated-flow.png]] 53 53 54 54 Just as with the entry gate we try to auto-generate as much as possible to make your life easier the moment you start in the Create phase. 55 55 56 -== ===Practice =====43 +== 4. Key takeaways == 57 57 58 -== 4. Assignment == 45 +* Each backend operation has a specific exit gate that: 46 +** Handles all incoming traffic destined for that backend operation 47 +** Connects to the backend operation to execute the requested action 48 +** Sends response back to the client that made the API call 49 +* eMagiz will automatically handle most of the setup for you, including the generation of the exit gate configuration. 50 +* Depending on your use cases, some manual changes might be necessary 59 59 60 -Open the exit flow, add basic authentication as an authentication method, and press Stop Editing. 61 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment. 52 +== 5. Suggested Additional Readings == 62 62 63 -== 5. Key takeaways == 64 - 65 -* Each backend operation has a specific exit gate that will 66 - * Handle all incoming traffic destined for that backend operation 67 - * Connect to the backend operation 68 - * Send response back to the client that is calling the API 69 -* eMagiz will automatically build the biggest portion of the exit gate for you 70 -* Some manual changes are necessary 71 - 72 - 73 - 74 -== 6. Suggested Additional Readings == 75 - 76 -If you are interested in this topic and want more information on it please read the help text provided by eMagiz. 77 - 78 -== 7. Silent demonstration video == 79 - 80 -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! 81 - 82 -<iframe width="1280" height="720" src="../../vid/microlearning/crashcourse-api-gateway-setting-up-exit-gate.mp4" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe> 83 - 84 -</div> 85 -</div> 86 -</div> 87 - 88 -{{/html}} 54 +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 link: 55 +* [[Crash Course (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]] 56 +** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]] 57 +*** [[Flow Editor - Basics (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-flow-editor-basics||target="blank"]] 58 +*** [[Promote flows to deploy (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-create-promote-flows-to-deploy||target="blank"]] 59 +** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]] 60 +*** [[Configure A Backend Operation (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-configure-backend-operation||target="blank"]] 61 +*** [[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"]] 62 +* [[Novice Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]] 63 +** [[SOAP Web service Connectivity (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.WebHome||target="blank"]] 64 +*** [[SOAP Headers (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.SOAP Web service Connectivity.novice-soap-webservice-connectivity-soap-headers||target="blank"]] 65 +* [[Intermediate Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]] 66 +** [[Testing API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Testing API Gateway.WebHome||target="blank"]] 67 +*** [[Testing API Gateway (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Testing API Gateway.intermediate-testing-emagiz-api-gateway-testing-api-gateway||target="blank"]] 68 +** [[Release Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Release Management.WebHome||target="blank"]] 69 +*** [[Container management (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.Release Management.intermediate-release-management-assigning-flows-2-containers.WebHome||target="blank"]] 70 +* [[Advanced Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]] 71 +** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.WebHome||target="blank"]] 72 +*** [[API Gateway Architecture (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.advanced-solution-architecture-apigw-architecture.WebHome||target="blank"]] 73 +*** [[Key differences Design & Deploy Architecture (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Solution Architecture.advanced-solution-architecture-diffs-design-deploy.WebHome||target="blank"]] 74 +** [[API Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.API Management.WebHome||target="blank"]] 75 +*** [[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"]] 76 +* [[Exit Gate (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=%22Exit+gate%22||target="blank"]] 77 +)))((({{toc/}}))){{/container}}{{/container}}