Apigee X Proxy Deployment Repository

A complete, production-ready repository for generating and deploying API proxies to Google Apigee X. All files are now in the root directory (C:\apigeex-template).

Remote repository: https://github.com/syngenta-digital/apigeex-template.git

🚀 Quick Start

# 1. Clone this repository (or copy all files to your working directory)
git clone https://github.com/syngenta-digital/apigeex-template.git
cd apigeex-template

# 2. Configure your Apigee credentials
Copy-Item config\.env.example config\.env
# Edit config/.env with your credentials

# 3. Generate proxies
.\scripts\generate-all-proxies.ps1 -Environment dev

# 4. Deploy to Apigee X
.\scripts\deploy-all-proxies.ps1 -Environment dev

📋 Prerequisites

• PowerShell 5.1 or higher (Windows) or PowerShell Core 7+ (Mac/Linux)
• Git 2.x or higher
• Apigee X Account with deployment permissions
• apigeecli (optional, for direct CLI deployment)

📚 Documentation

• Quick Start Guide - Get started in 5 minutes
• Deployment Guide - Detailed deployment instructions
• Configuration Reference - All configuration options
• Troubleshooting - Common issues and solutions

🏗️ Repository Structure

C:\apigeex-template\
├── .github\workflows\         # CI/CD pipelines
├── config\                    # Configuration files
├── templates\                 # Apigee proxy templates
├── scripts\                   # PowerShell automation
├── services\                  # Service definitions
├── generated\                 # Generated proxies (gitignored)
├── tests\                     # Test scripts
├── docs\                      # Documentation
├── README.md, QUICKSTART.md, DEPLOYMENT-GUIDE.md, CONFIGURATION-REFERENCE.md
└── .gitignore, LICENSE

Key Features:

• Template-based proxy generation (consistent structure)
• Multi-environment support (dev, qa, prod)
• Bulk operations (generate/deploy multiple proxies)
• Policy management (pre-configured security/operational policies)
• CI/CD ready (GitHub Actions workflows)

🔧 Features

✅ Proxy Generation

• Generate individual or bulk API proxies
• Template-based configuration
• Environment-specific customization
• Automatic bundle creation

✅ Deployment

• Deploy to multiple environments (dev/qa/prod)
• Automatic versioning
• Rollback support
• Deployment validation

✅ Policy Management

• Pre-configured security policies
• OAuth 2.0 authentication
• Rate limiting and quota management
• Error handling and logging

✅ Testing

• Automated proxy testing
• Health check endpoints
• Integration test support

📦 What's Included

• Templates - Apigee X proxy templates and policies
• Scripts - PowerShell automation for setup, generation, deployment, and testing
• CI/CD - GitHub Actions workflows for dev/qa/prod
• Documentation - Quickstart, deployment, configuration, and troubleshooting guides
• Examples - Sample service definitions and test configs

🎯 Usage Examples

Generate and Deploy All Proxies

# Define your services in services/api-services.json
.\scripts\generate-all-proxies.ps1 -Environment dev
.\scripts\deploy-all-proxies.ps1 -Environment dev

Deploy to QA or Production

.\scripts\generate-all-proxies.ps1 -Environment qa
.\scripts\deploy-all-proxies.ps1 -Environment qa
.\scripts\generate-all-proxies.ps1 -Environment prod
.\scripts\deploy-all-proxies.ps1 -Environment prod

⚙️ Configuration

Environment Configuration

Edit config/environments/{env}.json:

{
  "environment": "dev",
  "organization": "your-org",
  "domain": "dev.api.example.com",
  "authentication": {
    "type": "oauth2",
    "tokenEndpoint": "https://oauth.example.com/token"
  },
  "rateLimit": {
    "quota": 1000,
    "interval": "1",
    "timeUnit": "hour"
  }
}

Apigee Credentials

Edit config/.env:

APIGEE_ORG=your-organization
APIGEE_ENV=dev
APIGEE_TOKEN=your-access-token
# OR use service account
GOOGLE_APPLICATION_CREDENTIALS=path/to/service-account.json

🔐 Security Best Practices

1. Never commit credentials - Always use .env files
2. Use service accounts - Prefer service account authentication
3. Rotate tokens regularly - Set up token rotation
4. Review policies - Audit security policies before deployment
5. Limit permissions - Use principle of least privilege

🧪 Testing

# Test proxy configuration
.\scripts\test-proxy.ps1 -ProxyName "my-api" -Environment dev

# Run all tests
.\tests\proxy-tests.ps1

🚢 CI/CD Integration

Workflows are pre-configured in .github/workflows/:

• deploy-dev.yml – Auto-deploy to dev on push to develop branch
• deploy-qa.yml – Deploy to qa on push to release/* branch
• deploy-prod.yml – Deploy to prod on push to main branch

Configure GitHub Secrets:

• APIGEE_ORG
• APIGEE_TOKEN or GCP_SERVICE_ACCOUNT_KEY

📖 Learning Resources

• Apigee X Documentation
• Quick Start Guide
• Deployment Guide
• Configuration Reference
• Troubleshooting Guide

🤝 Contributing

Contributions are welcome! Please read our contributing guidelines:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🆘 Support

• Issues: Use your team's issue tracker or GitHub Issues
• Discussions: Use your team's chat or GitHub Discussions
• Email: support@example.com

🗺️ Roadmap

• Support for gRPC APIs
• GraphQL proxy templates
• Advanced traffic management policies
• Real-time monitoring dashboard
• Terraform integration
• Multi-cloud deployment support

🙏 Acknowledgments

Built with ❤️ for the API community.

---

---

Version: 1.0.0 Last Updated: January 29, 2026