Skip to content

Apigee Go Gen

Go Report Card GitHub release License

The apigee-go-gen CLI tool streamlines your Apigee development experience using Go style templates with a YAML centric workflow.

Here's what you'll find:

  • Transformation commands Easily convert between Apigee's API proxy format and YAML for better readability and management.
  • Template rendering commands Enjoy powerful customization and dynamic configuration options, inspired by the flexibility of Helm using the Go text/template engine.
  • Mock generation command Effortlessly create a mock API proxy from your OpenAPI 3.X Description, complete with dynamic response bodies, headers, and status codes.

By using this tool alongside the Apigee CLI, you'll unlock a highly customizable workflow. This is perfect for both streamlined local development and robust CI/CD pipelines.

Why use YAML

The traditional Apigee API proxy bundle format has certain characteristics that can present challenges:

  • XML Format: XML is a polarizing format. While it offers advantages like legacy tooling support and well-defined schema validation, its verbosity can make it less ideal for smaller configuration files.

  • Prescriptive Structure: The structure of API proxy bundles can feel somewhat rigid, potentially limiting flexibility in terms of re-use and customization. This often leads Apigee customers to develop their own systems to manage, adapt, and deploy these bundles across environments.

What if there was a better way? ...

You can define Apigee API Proxies using YAML configuration files and customize them with a flexible templating system.

This approach has the potential to address the current challenges, offering:

  • Improved readability

    YAML's streamlined syntax enhances clarity compared to XML.

  • Enhanced flexibility

    Templating empowers customization and reuse.

  • Repeatable engagements

    Leverage consistent set of tools to address API proxy use-cases across the business

  • Faster time to production

    Leverage Apigee community templates to save time and resources.

  • Stay in sync with API descriptions

    Auto-update templated API Proxies to stay in sync with the api description, while preserving customizations.

Support

This is not an officially supported Google product.