Skip to content

Render API Proxy

This command takes a YAML template representing an API proxy and creates a traditional (XML-based) Apigee API proxy bundle.

Under the hood, this command combines the render template and transform yaml-to-apiproxy commands into one

Using a template based workflow offers several advantages over working directly with the traditional Apigee API proxy bundle. e.g.

  • Enhanced Customization

    Tweak your API proxy configurations with the readability of YAML.

  • Seamless OAS Description Synchronization

    Template-generated API proxy bundles can be easily synced with your descriptions by re-generating them when changes occur.

  • Streamline Your Development

    YAML's versatility allows for easy version control, automation, and integration into CI/CD pipelines.

Usage

The render apiproxy command takes the following parameters:

  -t, --template string          path to main template"
  -i, --include string           path to helper templates (globs allowed)
  -o, --output string            output directory or file
      --debug boolean            prints rendered template before transforming into API proxy"
  -d, --dry-run enum(xml|yaml)   prints rendered template after transforming into API Proxy"
  -v, --validate boolean         check for unknown elements
      --set string               sets a key=value (bool,float,string), e.g. "use_ssl=true"
      --set-string string        sets key=value (string), e.g. "base_path=/v1/hello" 
      --values string            sets keys/values from YAML file, e.g. "./values.yaml"
      --set-file string          sets key=value where value is the content of a file, e.g. "my_data=./from/file.txt"
      --set-oas string           sets key=value where value is an OpenAPI Description, e.g. "my_spec=./petstore.yaml"
      --set-grpc string          sets key=value where value is a gRPC proto, e.g. "my_proto=./greeter.proto"
      --set-graphql string       sets key=value where value is a GraphQL schema, e.g. "my_schema=./resorts.graphql"
      --set-json string          sets key=value where value is JSON, e.g. 'servers=["server1","server2"]'