Search: "api gateway"
Last modified by Rico Kieboom on 2022/04/11 14:18
Refine your search
Select a category and activate filters on the current results
Last modification date
eMagiz API Gateway
Located in
- Title
eMagiz API Gateway
- Raw document content
Key concepts == * Explain API Management within eMagiz == 3. Introducing API Gateway == The eMagiz API Gateway is the pattern in which a specific entry point is made available for external applications (users).
…[[image:Main.Images.Fundamental.WebHome@fundamental-api-gateway-introduction-3.png]] === 3.6 Architectural components === A simplified picture below illustrates the overall architecture of API Gateway in the eMagiz Cloud. [[image:Main.Images.Fundamental.WebHome@fundamental-api-gateway-introduction-6.png]] == 4. Key takeaways == * API Gateway can serve as a single entry point for all external or intern application users * API Gateway can simplify the IT landscape by offering a reusable entry point * API Gateway is a synchronous pattern by default * API Gateway leverages the standard capability of eMagiz around deployment, transformation, and business owner interaction == 5.
- Page
fundamental-api-gateway-introduction
Testing API Gateway
Located in
- Title
Testing API Gateway
- Attachment name
intermediate-testing-emagiz-api-gateway-testing-the-api-gateway--feedback-inswagger-ui.png
…intermediate-testing-emagiz-api-gateway-testing-the-api-gateway--flow-test-configuration.png
…intermediate-testing-emagiz-api-gateway-testing-the-api-gateway--swagger-ui-execute-try-it-out.png
- Page
intermediate-testing-emagiz-api-gateway-testing-api-gateway
- Location
-
…
Testing API Gateway
- Raw document content
Testing API Gateway == In this microlearning, we will focus on testing your API Gateway (operations) with the help of two functionalities that the platform offers.
…By pressing this button you will test the API Gateway functionality of a specific operation as if you were the client. [[image:Main.Images.Microlearning.WebHome@intermediate-testing-emagiz-api-gateway-testing-the-api-gateway--swagger-ui-execute-try-it-out.png]] The Swagger UI will give feedback based on what happened after you have pressed the button to execute [[image:Main.Images.Microlearning.WebHome@intermediate-testing-emagiz-api-gateway-testing-the-api-gateway--feedback-inswagger-ui.png]] == 4.
API Gateway - Introduction
Located in
- Title
API Gateway - Introduction
- Page
crashcourse-api-gateway-introduction
- Location
-
…
Crash Course API Gateway
- Raw document content
[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-introduction--conceptual-overview.png]] Key considerations when to use the API Gateway integration pattern Below is the list of considerations when to use the API Gateway
…Managing your API Gateway in the ILM == The API Gateway is fully embedded into the eMagiz Low-code Enterprise iPaaS so that users have a similar user experience when configuring the API Gateway, a Messaging integration, or an Event Stream.
…* Manage phase specific to the API Gateway In this phase, everything works as usual.
API Gateway Architecture
Located in
- Title
API Gateway Architecture
- Raw document content
Architecture considerations == === 3.1 Architecture components API Gateway === The following picture displays a general architecture of the API Gateway.
…The eMagiz Cloud handles the proper and secure routing to the API gateway. * Gateway only runtime ** These are system that act as application user of 1 or more operations made available in the API Gateway.
…For the API Gateway, this means that you have the following machines available.
Testing API Gateway
Located in
- Title
Testing API Gateway
- Location
-
…
Testing API Gateway
…intermediate-testing-emagiz-api-gateway-testing-api-gateway-exercise
- Raw document content
{{container}}{{container layoutStyle="columns"}}((( This exercise will guide you in practising with testing in API Gateway. Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]]. == 1.
…When satisfied please run your API Gateway locally and access the Swagger UI via the browser.
…{{video attachment="intermediate-testing-api-gateway-testing-api-gateway.mp4" reference="Main.Videos.Microlearning.WebHome"/}} )))((({{toc/}}))){{/container}}{{/container}}
API Gateway Data Model
Located in
- Title
API Gateway Data Model
- Attachment name
crashcourse-api-gateway-api-data-model--access-data-model-in-design.png
…crashcourse-api-gateway-api-data-model--create-new-version-pop-up.png
… …crashcourse-api-gateway-api-data-model--history-of-data-model.png
- Page
crashcourse-api-gateway-api-data-model
- Location
-
…
Crash Course API Gateway
- Raw document content
So, for example your data model could look like this after you have imported two separate XSD files into the API Gateway Data Model: [[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-api-data-model--import-data-model-in-design-filled-in.png]] === 3.1 Saving your changes === After you are done with editing on this data model you can press "Stop Editing" and you will be presented with the following pop-up: [[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-api-data-model--create-new-version-pop-up.png]] At this point, you have to make a choice.
…You can view who made what (temporary) version when you navigate to the History option on the API Gateway Data Model level. [[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-api-data-model--history-of-data-model.png]] This history of the changes on the API Gateway Data Model is not only useful for auditing purposes, but also helps you identify who you should ask about the latest changes.
…[[image:Main.Images.Microlearning.WebHome@crashcourse-api-gateway-api-data-model--edit-description-auto-saved-version-result.png]] == 4.
Transforming messages in API Gateways
Located in
- Title
Transforming messages in API Gateways
- Attachment name
intermediate-configuring-the-api-gateway-transforming-messages--operation-options-transformation.png
- Page
intermediate-configuring-the-api-gateway-transforming-messages
- Location
-
…
Configuring the API Gateway
- Raw document content
Prerequisites == * Intermediate knowledge of the eMagiz platform * Basic knowledge of the API Gateway pattern == 2. Key concepts == This microlearning is about transforming messages within the API Gateway pattern
…Interesting points to consider are: * The transformation process works similarly across patterns * The benefit of having the transformation capability is that it expands the capabilities of the API Gateway. This fact makes it more attractive to use the eMagiz API Gateway * You can transform from the different messaging formats (including itself) with the standard transformation functionality (for the API Gateway) == 3. Transforming messages == In the [[Crash Course of API Gateway>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]], we learned the basics of the API Gateway pattern.
Considerations for API Gateway or Messaging
Located in
- Title
Considerations for API Gateway or Messaging
- Location
-
…
Key Concepts API Gateway
- Raw document content
Considerations for API Gateway or Messaging == The following sections are helpful to understand what things to consider in selecting the right pattern
…The same is true for a backend API provider which needs to be online to provide or consume data from API operations * **Error handling** ** In the case of an API Gateway, the requesting application needs to be handle the error messages that are returned by the API gateway in case there are any.
…A change of definition would result in validation issues and therefore more communication is required ** For an API Gateway solution, the contract is published via the API Gateway outwards.
Constructing Error Handling API Gateway
Located in
- Title
Constructing Error Handling API Gateway
- Attachment name
intermediate-api-management-constructing-error-handling-api-gateway--catalog-context-menu.png
…intermediate-api-management-constructing-error-handling-api-gateway--catalog-response-tab.png
…intermediate-api-management-constructing-error-handling-api-gateway--new-response.png
- Page
intermediate-api-management-constructing-error-handling-api-gateway
- Raw document content
{{/error}} As we learned from our crash course on API Gateway we can influence the error handling within the API Gateway solution.
…Constructing Error Handling API Gateway == As we learned from our crash course on API Gateway we can influence the error handling within the API Gateway solution.
…When you are satisfied with your configuration you can save the custom error handler and update your API Gateway. To learn about how to update your API Gateway solution please continue with the next microlearning. == 4.
Updating your API Gateway Operations
Located in
- Title
Updating your API Gateway Operations
- Attachment name
intermediate-api-management-updating-your-api-gateway-operations--reset-flow-context-menu.png
…intermediate-api-management-updating-your-api-gateway-operations--reset-flow-warning.png
- Page
intermediate-api-management-updating-your-api-gateway-operations
- Raw document content
Updating your API Gateway Operations == In our [[crash course>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]] on the API Gateway pattern, we have learned about setting up the API Gateway. However, we still need to delve into how to update your existing API Gateway solution. In this microlearning, we will focus on updating the design phase of your API gateway (and the subsequent steps) and the create phase of your API gateway (and subsequent steps).
…The actual change in these parts of the API Gateway solutions is specified in earlier microlearnings.