apigee-apihub-maven-plugin

---

About the Plugin

apigee-apihub-maven-plugin is a utility for creating, updating, deleting APIs into the Apigee API Hub. For more info on Apigee API Hub, check this link

The code is distributed under the Apache License 2.0.

The samples folder provides a README with Getting Started steps and commands to hit the ground quickly.

Prerequisites

You will need the following to run the samples:

• Apigee API hub provisioned
• Apigee API hub admin role
• Java SDK >= 8
• Maven 3.x

Plugin Usage

To use the plugin, add the following dependency to your pom

<dependency>
  <groupId>com.apigee.apihub.config</groupId>
  <artifactId>apigee-apihub-maven-plugin</artifactId>
  <version>1.x.x</version>
</dependency>

Command

mvn install -P<profile> -Dapigee.apihub.config.dir=$path -Dapigee.apihub.config.options=$option

Options

mvn install -P{profile} -DprojectId=${project} -Dfile={path}

  # Options

  -P<profile>
    Pick a profile in the pom.xml.
    Apigee API Hub location, config directory, option are picked from the profile.

  -Dapigee.apihub.config.options
    none   - No action (default)
    create - Create when not found. Pre-existing config is NOT updated even if it is different.
    update - Update when found; create when not found
    delete - Delete when found
    export - export all entities to a file
    sync   - Delete and recreate.
    
  -Dapigee.apihub.config.dir
  	path to the directory containing the configuration
  
  -Dapigee.apihub.config.exportDir
  	path to the directory where the entities will be exported to
  	
  -Dapigee.apihub.force.delete
  	set this flag to true to forcefully delete all dependent entities (applicable for apis and apiversions)
  
  -Dbearer
  	access token. Service Account file takes precedence
    

Individual goals

To execute individual goals, you can use the prefix apigee-apihub:<goal>, for example apigee-apihub:attributes

The list of goals available are:

• apis
• apiversions
• specs
• attributes
• dependencies
• externalapis
• deployments

An example to just configure attributes will look like

mvn apigee-apihub:attributes -Pdev -Dapigee.apihub.config.options=create -Dapigee.apihub.config.dir=./config

NOTE: The config files must be in a single directory and should match the below naming conventions:

Goal	File name
apis	apis.json
apiversions	apiVersions.json
specs	specs.json
attributes	attributes.json
externalapis	externalApis.json
dependencies	dependencies.json
deployments	deployments.json

Support

• Please send feature requests using issues
• Post a question in Apigee community
• Create an issue

Disclaimer

This is not an officially supported Google product.