AWS API Gateway Adapter
AWS API Gateway is a new data adapter of Quantum Fabric integration services. With Quantum Fabric AWS API Gateway integration service, you can connect to the services configured and deployed under API Gateway Service in Amazon Web Services.
Quantum Fabric AWS API Gateway supports the following integration types of Amazon API Gateway:
- Lambda Function
- HTTP Proxy
- Mock Integration
- AWS Service Proxy
NOTE: Quantum Fabric supports AWS API Gateway services, which returns JSON response.
Configure AWS API Gateway Endpoint Adapter
To configure AWS API Gateway service in the Integration Service Definition tab, follow these steps:
- In the Name field, provide a unique name for your service.
- From the Service Type list, select AWS API Gateway.
- Provide the following details in the AWS API Gateway service definiton:
-
NOTE: All options in the Advanced section are optional.
-
In the Description field, provide a suitable description for the service.
-
To enable the proxy, select the Use proxy from settings check box. By default, the check box is cleared.
The Use proxy from settings check box dims when no proxy is configured under the Settings > Proxy. -
Click Save to save your service definition.
Field | Description |
---|---|
Regions | Select your region that you have configured AWS API Gateway for your AWS account. |
AWS URL | It displays the AWS API gateway URL for the selected region. You cannot modify this field. |
Access Key ID | Enter the access key ID that you received from your AWS account. |
Secret Access ID | Enter the secret access key ID that you received from your AWS account. |
Test Connection |
Click Test Connection to test you AWS connection details. The system displays |
Create Operations for AWS API Gateway
The Operations List tab appears only after the service definition is saved.
NOTE: Click Operations List tab > Configure Operation. The Configured Operations list appears.
To create an operation, follow these steps:
- Click SAVE & ADD OPERATION in your service definition page to save your service definition and display the NewOperation tab for adding operations.
OR
Click Add Operation to add a new operation or from the tree in the left pane, click Add > Add New Operation.
-
To create an operation, provide the following details:
Field Description API From the drop down list, select an API that is deployed at Amazon Services. Resource Select the required resource from the drop down list. Stages Select the required stage from the drop down list. Methods Select the required method from the drop down list. Add Operation Click Add Operation to add the created operation in the Configured Operations Section. Operation names are auto-generated in the format. The default name format of a AWS API operation is <method_name><api_name><resource_name>
. You can change the operation name if required.
Configure Operation for AWS API Gateway
Once you create operations for an AWS API Gateway service, you can configure operations as follows:
- To edit an operation, either click on the required operation name or click Edit from the Contextual Menu in the Configured Operations screen. The operation details page is displayed.
- Provide the following details in the operation details page:
-
NOTE: All options in the Advanced section are optional.
Field | Description |
---|---|
Name | It is prepopulated with the operation name. You can change the name if required. |
Operation Security Level |
It specifies how a client must authenticate to invoke this operation. |
Configure Request Operation for AWS API Gateway
Integration services accept only form-url-encoded
inputs for all input parameters provided in service input parameters (request input).
You can perform the following actions in Request Input tab:
- Click Add Parameter to add an entry (if the entries for input and the output tabs does not exist).
- To make duplicate entries, select the check box for the entry, click Copy and Paste.
- To delete an entry, select the check box for an entry and click Delete .
- Under the Body tab, provide the following details:
- Request indicates that the value must be retrieved from the HTTP request received from the mobile device.
- Session indicates that the value must be retrieved from the HTTP session stored on Quantum Fabric.
- Under the Header tab, provide the following details:
IMPORTANT: If AWS APIs with API Key Required is set to "true", the api key needs to be sent as request header as x-api-key.
-
To validate the operation details, click Save and Test. For more details, refer to Test a Service Operation.
Field | Description |
---|---|
Name | It Contains a Unique Identifier. Change the name if required. |
Test Value | Enter a value. A test value is used for testing the service. |
Default Value | Enter the value, if required. The default value will be used if the test value is empty. |
Scope |
Select Request or Session. It is set to Request by default. |
Datatype | |
Encode |
Select the check box to enable encoding of an input parameter. For example, the name New York Times would be encoded as New%20York%20Times when the encoding is set to True. The encoding must also adhere to the HTML URL encoding standards. |
Field | Description |
---|---|
Name | Provide custom HTTP headers required by the external source. |
Scope |
NOTE: You cannot edit the default value for the expression. |
Test Value | Enter a value. A test value is used for testing the service. |
Default Value | Enter the value, if required. The default value will be used if the test value is empty. |
Description |
Provide a suitable description of the service. |
Configure Response Operation for AWS API Gateway
- In the Response Output tab, provide the following details:.
The Name field in the Response Output tab is prepopulated with properties of the output API.
Enter the values for required fields such as name, scope, data type, collection ID, record ID, format and format value.
NOTE: If you define parameters inside a record as a session, the session scope will not get reflected for the parameters.
- To validate the operation details, click Save and Test. For more details, refer to Test a Service Operation.
- Click Save Operation to save the operation. The system displays the Operation section for your service.
NOTE: You can view the service in the Data Panel feature of Quantum Visualizer. By using the Data Panel, you can link back-end data services to your application UI elements seamlessly with low-code to no code. For more information on Data Panel, click here.