This page walks you through deploying a sample API with Google Cloud Endpoints. The sample code includes:
- A REST API that you can query to find the name of an airport from its three-letter IATA code.
- A script that uploads the API configuration to Cloud Endpoints.
- A script that deploys a Google App Engine flexible backend to host the sample API.
After you send some requests to the sample API, you can view the Cloud Endpoints Activity Graphs and Logs, tools that allow you to monitor your APIs and gain insights into their usage.
Before you begin
Starting Cloud Shell
- Click the Activate Google Cloud Shell button at the top of the console
A Cloud Shell session opens inside a new frame at the bottom of the console and displays a command-line prompt. It can take a few seconds for the shell session to be initialized.
- Enter the following in Cloud Shell to display the project IDs for your
gcloud projects list
- Set the default project to the one that your are using for this Quickstart.
gcloud config set project [YOUR-PROJECT-ID]
[YOUR-PROJECT-ID]with your project ID. Do not include the square brackets.
Getting the sample code
Enter the following command in Cloud Shell to get the sample API and scripts:
git clone https://github.com/GoogleCloudPlatform/endpoints-quickstart
Change to the directory that contains the sample code:
Deploying the Endpoints Configuration
To publish a REST API to Endpoints, an Open API configuration file that
describes the API is required. The sample API comes with a pre-configured
Open API file called
Cloud Endpoints uses Google Service Management, an infrastructure service of Cloud Platform to create and manage APIs and services. To use Endpoints to manage an API, you deploy the API's Open API configuration to Service Management.
To deploy the Endpoints configuration:
endpoints-quickstartdirectory, enter the following in Cloud Shell:
Run the following script, which is included in the sample:
Cloud Endpoints uses the
host field in the Open API configuration file to
identify the service. The
deploy_api.sh script sets the ID of your Cloud
project as part of the name configured in the
host field. (When you
prepare an Open API configuration file for your own service, you will need to
do this manually.)
The script then deploys the Open API configuration to Service Management using
gcloud service-management deploy openapi.yaml
As it is creating and configuring the service, Service Management outputs a
great deal of information to the console. You can safely ignore the warnings
about the paths in
openapi.yaml not requiring an API key. On successful
completion, you see a line like the following that displays the service
configuration ID and the service name:
Service Configuration [2017-02-13-r2] uploaded for service [airports-api.endpoints.example-project.cloud.goog]
Deploying the API Backend
So far you have deployed the Open API configuration to Service Management, but
you have not yet deployed the code that will serve the API backend. The
deploy_app.sh script included in the sample creates an App Engine flexible
environment to host the API backend, and then the script deploys the API
to App Engine.
To deploy the API backend:
endpoints-quickstart/scripts directory, run the following script:
The script runs the following command to create an App Engine flexible
environment in the us-central region:
gcloud app create --region="$REGION"
It takes a several seconds to create the App Engine flexible backend. You'll see the following displayed on the console after the App Engine is created:
Success! The app is now created. Please use `gcloud app deploy` to deploy your first app.
Next, the script runs the
gcloud app deploy command to
deploy the sample API to App Engine.
You'll see a line like the following in the console:
Deploying ../app/app_template.yaml...You are about to deploy the following services:
It takes several minutes for the API to be deployed to App Engine. You'll see a line like the following when the API is successfully deployed to App Engine:
Deployed service [default] to [https://example-project.appspot.com]
Sending Requests to the API
After deploying the sample API, you can send requests to it by running the following script:
The script echoes the
curl command that it uses to send a request to the API,
and then displays the result. You'll see something like the following on the
curl "https://example-project.appspot.com/airportName?iataCode=SFO" San Francisco International Airport
The API expects one query parameter,
iataCode, that is set to a valid IATA
airport code such as
JFK. For example:
Note: App Engine may take a few minutes to respond successfully to requests. If you send a request and get back an HTTP 502, 503, or some other server error, wait a minute and try the request again.
You just deployed and tested an API in Cloud Endpoints!
Tracking API activity
With APIs deployed with Cloud Endpoints, you can monitor critical operations metrics in Google Cloud Platform Console, and gain insight into your users and usage with Google Cloud Logging.
Run the traffic generation script to populate the graphs and logs.
Look at the activity graphs for your API in the Endpoints page.
View Endpoints activity graphs
It may take a few moments for the requests to be reflected in the graphs. While you wait for data to be displayed:
If the Permissions side panel is not open, click +Permissions. The Permissions panel allows you to control who has access to your API and the level of access.
Click Deployment history. This tab displays a history of your API deployments, including the deployment time and who deployed the change.
Click Overview. You should see the traffic coming in. After the traffic generation script has been running for a minute, you should see three lines on the Total latency graph (50th, 95th, and 98th percentiles). This data provides a quick estimate of response times.
Scroll down to the bottom of the Endpoints graphs, and under Method, click GET/airportName. The Logs Viewer page displays the request logs for the API.
Click the Activate Google Cloud Shell button at the top of the console window to display the Cloud Shell.
Ctrl-Cto stop the script.
To avoid incurring charges to your Google Cloud Platform account for the resources used in this quickstart:
Note that the script deletes the entire project.
- For on overview of Cloud Endpoints:
- To learn how to deploy a sample API without using scripts:
- To learn about the different API frameworks that Cloud Endpoints supports: