apigateway: add binaryMediaTypes property to SpecRestApi construct

[giuliotripi]

Describe the feature

The SpecRestApi construct should accept as one of his construct props a binaryMediaTypes property that is the list of binary media mime-types that are supported by the resource.

This is already supported by the RestApi construct and by the underlying CloudFormation resource:

• https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html
• https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.SpecRestApi.html
• https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-apigateway-restapi.html
• https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings.html#api-gateway-payload-encodings-proxy

Use Case

When the API Gateway have to return binary data the mime-type has to be added in the API Gateway settings via the BinaryMediaTypes property.

Proposed Solution

Add the binaryMediaTypes to the SpecRestApi construct

Other Information

At the moment the alternative solution is to use escape hatches: https://docs.aws.amazon.com/cdk/v2/guide/cfn-layer.html

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

AWS CDK Library version (aws-cdk-lib)

2.213.0

AWS CDK CLI version

2.174.1

Environment details (OS name and version, etc.)

Linux

[pahud]

Hi @giuliotripi,

Thank you for this feature request! You're absolutely right that the binaryMediaTypes property should be available on the SpecRestApi construct, just like it is on the RestApi construct.

This is a straightforward enhancement that would involve:

• Adding the binaryMediaTypes?: string[] property to the SpecRestApiProps interface
• Updating the SpecRestApi constructor to pass this property to the underlying CloudFormation resource

The implementation should be relatively simple since the underlying AWS::ApiGateway::RestApi CloudFormation resource already supports the BinaryMediaTypes property.

Since you mentioned you may be able to implement this feature request, we'd welcome a pull request! The changes would need to be made in the packages/aws-cdk-lib/aws-apigateway/lib/restapi.ts file. You would also want to add appropriate unit tests to ensure the property is correctly passed through to the CloudFormation template.

Would you like to take a shot at implementing this enhancement?