Reference API Gateway Models in CloudFormation
API Gateway Models are defined using JSON Schema. You can reference a Model inside another Model using the
$ref field. If you are familiar with the OpenAPI Specification fka Swagger, you may have seen something like this:
To make model references work with API Gateway, you need to provide an absolute reference that is predefined by AWS:
Let’s translate this to a CloudFormation template:
That’s it. Now you can build sophisticated API Gateway models that reference each other in CloudFormation.