You can create an HTTP API and a route in Cloud-native API Gateway to expose services deployed in Serverless App Engine (SAE) applications to external systems or clients. This topic describes how to configure an HTTP API to access services in SAE applications.
Prerequisites
-
A Cloud-native API Gateway instance is created. For more information, see Create a gateway instance.
-
An SAE application is created in the same virtual private cloud (VPC) as the gateway instance. For more information, see Deploy a microservices application by using a JAR package in the SAE console.
-
Access based on Kubernetes (K8s) service names is configured for the SAE application. For more information, see Configure application access based on Kubernetes Service names.
Process overview
-
Create an HTTP API: Configure the basic information of the API.
-
-
Configure routing rules: Configure how the API maps to the K8s service in the SAE application to ensure that requests are accurately routed to the destination service.
-
Environment and backend service: Select the gateway instance (environment) and define the backend service where the route will be deployed.
-
Associate the service: Associate service instances with the routing rules to enable dynamic service discovery and scheduling.
-
-
Debug the route: Verify the integration between Cloud-native API Gateway and the K8s service by simulating requests and analyzing responses.
Procedure
Step 1: Create an HTTP API
Log on to the API Gateway console.
In the left-side navigation pane, click . In the top navigation bar, select a region.
-
On the APIs page, click Create API in the upper-left corner.
-
Select HTTP API and click Create. On the Create HTTP API page, enter the API Name and Description.
Step 2: Create a route
Click the name of the API that you want to manage. On the API details page, click Create Route. In the Create Route panel, configure the parameters.
1. Configure basic route information
In this example, set Route Name to springcloud-entry. For the Path matching condition, select Prefix, enter /, and select Case sensitive.
The following items describe the parameters:
-
Route Name: the name of the route. The name cannot be modified after the route is created.
-
Domain Name: You can click Add Domain Name to create a domain name.
-
Path: Matches HTTP requests whose path starts with
/.
2. Environment and backend service
-
For Instance, select the target Cloud-native API Gateway instance.
In the Backend services section, select the Service name, Service port, and Service protocol.
-
For Scenario, select Single Service.
3. Create a service
-
In the Backend Services section, click the drop-down list for Service Name and then click Create Service.
-
Set Source Type to SAE Kubernetes.
The following items describe the parameters for creating a service:
-
Namespace: Select an existing namespace in SAE from the drop-down list.
-
Services: Select the K8s service registered in the SAE application from the list.
-
-
Save and publish the route.
Step 3: Debug the route
-
After the route is published, find the route in the route list and click Debug in the Actions column.
-
In the debugging panel, configure the input parameter and click Send. The response of the API is displayed on the right.
In this example, a GET request is sent to the target domain name item.dev. The response has an HTTP status code of 200, a response time of 12 ms, and a body of
false.
References
-
For information about how to open your application in a container service for public access, see Access applications in ACK by using an HTTP API.
-
For more information about the frequently asked questions (FAQ) about using Cloud-native API Gateway, see FAQ.