Skip to content

Latest commit

 

History

History
150 lines (117 loc) · 4.18 KB

README.md

File metadata and controls

150 lines (117 loc) · 4.18 KB
Raw

Apigee on top of Data APIs

This reference provides a basic proxy generator that allows you to build an API facade on a data platform. (In this example we are using BigQuery as the data platform but the same principles could be applied to other products.)

The API proxy provides the following functionality to facilitate and govern data consumption via APIs:

  • Response Cache
  • Quota (Default or API Product)
  • Return Size Limit (with enforced max)
  • Pagination
  • Fields Selection
  • Injection Protection (Using Regex Matching)
  • CORS headers

Getting Started

Configure the SA to be used by Apigee

SA=bq-reader
SA_EMAIL="$SA@$APIGEE_X_ORG.iam.gserviceaccount.com"
BQ_PROJECT_ID='my-bq-project'

gcloud iam service-accounts create "$SA" --project="$APIGEE_X_ORG" --display-name="BQ data reader"
gcloud projects add-iam-policy-binding "$BQ_PROJECT_ID" --member="serviceAccount:$SA_EMAIL" --role="roles/bigquery.dataViewer" --quiet
gcloud projects add-iam-policy-binding "$BQ_PROJECT_ID" --member="serviceAccount:$SA_EMAIL" --role="roles/bigquery.user" --quiet

Template the proxy

export BQ_PROJECT_ID='my-bq-project'
export BASE_PATH='/london/v1/bikerentals'
export DATA_SET='bigquery-public-data.london_bicycles.cycle_hire'

export PROXY_NAME="$( tr '/' '-' <<< ${BASE_PATH:1})"

rm -rf "./$PROXY_NAME/"
mkdir "./$PROXY_NAME/"
cp -r template/. "./$PROXY_NAME/"

find ./$PROXY_NAME -name '*.xml' -print0 |
while IFS= read -r -d '' file; do
    echo "replacing variables in $file"
    envsubst < "$file" > "$file.out"
    mv "$file.out" "$file"
done

mv "./$PROXY_NAME/apiproxy/proxy.xml" "./$PROXY_NAME/apiproxy/$PROXY_NAME.xml"

Deploy the proxy

APIGEE_TOKEN=$(gcloud auth print-access-token);
APIGEE_X_ORG="$PROJECT_ID"
APIGEE_X_ENV="test1" # set this to the env you want to deploy to
sackmesser deploy -o $APIGEE_X_ORG -e $APIGEE_X_ENV -d "./$PROXY_NAME" -t "$APIGEE_TOKEN" --deployment-sa "$SA_EMAIL"

Try it out

APIGEE_X_HOSTNAME='my-proxy-hostname'

Basic API request:

curl "https://$APIGEE_X_HOSTNAME/london/v1/bikerentals" -v

Using query params:

curl "https://$APIGEE_X_HOSTNAME/london/v1/bikerentals?limit=3&fields=start_station_name,end_station_name" | jq

Triggering the quota limit for unauthenticated users:

curl "https://$APIGEE_X_HOSTNAME/london/v1/bikerentals?try=[1-20]" -I

Create an API product with a higher quota and an app for it.

# Create a Developer Resource
curl -X POST "https://apigee.googleapis.com/v1/organizations/$APIGEE_X_ORG/developers" \
-H "Authorization: Bearer $APIGEE_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "email": "[email protected]", "firstName": "test", "lastName": "user", "userName": "testdatauser" }' \

# Create an API Product with a Quota higher than the default 8 requests per minute
curl -X POST "https://apigee.googleapis.com/v1/organizations/$APIGEE_X_ORG/apiproducts" \
-H "Authorization: Bearer $APIGEE_TOKEN" \
-H "Content-Type: application/json" \
--data @<(cat <<EOF
{
  "name": "premium-data",
  "quota": "30",
  "quotaTimeUnit": "minute",
  "quotaInterval": "1",
  "proxies": [
    "$PROXY_NAME"
  ],
  "environments": [
    "$APIGEE_X_ENV"
  ],
  "displayName": "Premium Data Product",
  "approvalType": "auto"
}
EOF
)

# Create an App
curl -X POST "https://apigee.googleapis.com/v1/organizations/$APIGEE_X_ORG/developers/[email protected]/apps" \
-H "Authorization: Bearer $APIGEE_TOKEN" \
-H "Content-Type: application/json" \
--data @<(cat <<EOF
{
  "name": "premium-data-app",
  "apiProducts": [
    "premium-data"
  ]
}
EOF
)

Use the app's key in an x-apikey header in your request:

APIKEY="$(curl "https://apigee.googleapis.com/v1/organizations/$APIGEE_X_ORG/developers/[email protected]/apps/premium-data-app" \
-H "Authorization: Bearer $APIGEE_TOKEN" | jq -r '.credentials[0].consumerKey')"

curl -H "x-apikey=$API_KEY" "https://$APIGEE_X_HOSTNAME/london/v1/bikerentals?try=[1-20]" -I

Create an API Product in the Developer Portal:

envsubst '$APIGEE_X_HOSTNAME' < ./london-bike.spec.yaml > ./london-bikes-v1/spec.yaml

And use the templated spec file together with an appropriate picture to create a product in the Apigee Developer Portal.