FlexDeploy - Apigee Plugin Guide

@Since 5.0.0.3

This operation deploys an Apigee API proxy or Shared flow to Apigee by using the maven apigee deploy plugin. You must have built artifacts as zip file or expanded folder, see Extract and Save Artifacts workflow on FlexDeploy - Apigee Plugin Guide page under Example Workflows. See Special Considerations below for details on folder structure. You can download zip file from Apigee and commit to SCM for use during build, or you can commit zip file in expanded format.

The plugin unzips any zipped file within the artifacts and will search for the API proxy or Shared flow folder and deploy it to Apigee. This operation automatically generates a pom.xml and parent-pom.xml necessary to use with Maven for deployment. If it is already present, it will be replaced. The new pom contains property replacement tokens in many places. Passwords and other values will not be stored in the file.

If a config.json file is present in the folder it will be processed. The FDAGP_ENV variable holds the environment that will be used when making replacements.

Supported Versions

  • Tested on Apigee version 19.01.14

Key Features

  • Easily configured for deployment of API Proxy and Shared Flow.
  • Supports basic authentication.
  • No need to maintain maven pom files for deployment.

FlexDeploy Project Recommendations

Apigee ComponentFlexDeploy Project NamePurpose
API Proxy API Proxy Name

Manage single API proxy per FlexDeploy project. FlexDeploy project name should match proxy name for consistency.

Use SCM for source code for API Proxy. The artifacts within the FlexDeploy project can be zipped or an expanded folder.

Shared FlowShared Flow Name

Manage single Shared flow per FlexDeploy project. FlexDeploy project name should match Shared flow name for consistency.

Use SCM for source code for Shared flow. The artifacts within the FlexDeploy project can be zipped or an expanded folder.

Plugin Operations

Example Workflows

Simply create workflow with name and type shown below, click Save, go to Definition, click Source button, then download source code replace entire contents on Source popup.

Workflow NameWorkflow TypeSource CodeDescription
Extract and Save ArtifactsBuildExtract and Save Artifacts.xmlExtract files from supported SCM and save as artifacts for use during deploy.
ApigeeDeployDeployApigeeDeploy.xmlDeploy build artifact files to Apigee.